Microsoft.VisualStudio.Shell

Provides methods for dealing with common COM error codes.

Checks if an HRESULT is an error return code.

true if hr represents an error, otherwise false. The HRESULT to test.

Checks if an HRESULT is a success return code.

true if hr represents a success otherwise false. The HRESULT to test.

Checks if the parameter is a success or failure HRESULT and throws an exception in case of failure.

The HRESULT. The HRESULT to test.

Checks if the parameter is a success or failure HRESULT and throws an exception if it is a failure that is not included in the array of well-known failures.

The HRESULT. The HRESULT to test. If hr is found in this array of expected failures no exception should be thrown.

Provides the methods necessary to add, remove, and test for the existence of handlers in an event handler collection.

When implemented by a derived class, adds a named handler to an event handler collection.

if the method succeeds, otherwise an error code. The name of the handler.

When implemented by a derived class, returns an enumerator over all the handlers added by successive calls to .

if the method succeeds, otherwise an error code.

When implemented by a derived class, determines whether a named handler is in the event handler collection.

true if the handler is in the underlying handler collection, otherwise false. The name of the evaluated handler.

When implemented by a derived class, removes a named handler from the collection of event handlers.

if the method succeeds, otherwise an error code. The name of the event handler to remove.

Use this class to access common Visual Studio constants.

Use this legacy GUID to access a specific output pane.

An obsolete flag combined bitwise as the first parameter of the method .

Combined bitwise as the first parameter of the method , this indicates the editor factory should perform necessary corrections.

Combined bitwise as the first parameter of the method , this flag is mutually exclusive with .

Indicates the editor factory should create the editor silently.

The document's data is HTML format.

GUID of the HTML package.

GUID of the HTML language service.

CLSID for Miscellaneous Files project.

Project type CLSID for Solution Items project.

Provide notifications when configuration-related events are fired. Implemented by the environment.

The CLSID of the document outline package window.

The CLSID for Visual Studio Environment Package.

The CLSID for Visual Studio Environment Task List.

The CLSID for Visual Studio Environment Task List Package.

The CLSID for Visual Studio Environment Hierarchy Window.

On the Tools menu, the command for options.

Sent from a page dialog to Component Selector dialog, informs of selection change on page.

Sent from a page dialog to Component Selector dialog, informs of a double click on a selected item.

Resets and clears selection in list of available components on the Component Selector dialog.

Retrieves information about selection on the Component Selector dialog.

Initializes the list of available components on the Component Selector dialog.

Initializes a tab with in on the Component Selector dialog.

Determine whether the Select button should be enabled on the Component Selector dialog.

Sets the multiple-selection mode on the Component Selector dialog.

Use this legacy GUID to access a specific output pane.

An HRESULT that indicates that the array is currently locked.

A COM return value.

A return value that indicates subscript out of range.

An error return value that indicates that the number of elements provided to the method is different from the number of arguments accepted by the method.

One of the method arguments is not a valid variant type.

A return error that indicates the destination token buffer is too small.

A return error that indicates a divide by zero error.

This return value indicates that the call generated an exception. The usual implementation is to specify that an argument of the method that returned this error is a pointer to a structure that contains exception information.

A return value indicating that the requested member does not exist, or the call to Invoke tried to set the value of a read-only property.

A return value indicating that the invoked implementation of IDispatch does not support named arguments.

A return value indicating an unexpected argument type.

An error that indicates that a value could not be coerced to its expected representation.

A return value that indicates that one of the parameter DISPIDs does not correspond to a parameter on the method.

A return value that indicates that a required parameter was omitted.

A return value that indicates that one or more of the parameters could not be coerced.

A return value that indicates that the interface identifier passed in riid is not equal to IID_NULL.

A return value that indicates that the member being invoked interprets string arguments according to the Locale ID (LCID), and the LCID is not recognized. If the LCID is not needed to interpret arguments, this error should not be returned.

A return value that indicates that one or more of the names were not known. The returned DISPIDs contain DISPID_UNKNOWN for each entry that corresponds to an unknown name.

A constant referenced in selection events to describe which component of the shell has just been selected.

A return value that may indicate an explicit cancellation action or some process that could no longer proceed after (for instance) both undo and rollback failed.

A return value that describes a general access denied error.

Error HRESULT for a generic failure.

A return value that indicates an invalid handle.

Error HRESULT for an invalid argument.

Error HRESULT for the request of a not implemented interface.

Error HRESULT for the call to a method that is not implemented.

Error HRESULT for out of memory.

A return value that indicates the availability of an asynchronously accessed interface.

A return value that indicates that an invalid pointer, usually null, was passed as a parameter.

A return value that indicates that the result of the method call is outside of the error cases the client code can readily handle.

This constant represents the GUID for the interface which is implemented by the shell's OutputWindow tool window. It is used by client code to display messages in the output window.

A Visual Studio component selector page GUID.

A common system defined editor GUID.

A common editor GUID.

GUID used to mark a in order to tell to the HTML editor factory to accept preexisting doc data.

GUID of the HTML editor factory.

A GUID constant used to specify that the type is a physical file on disk or the Web.

A GUID constant used to specify that the type is a physical folder on disk or the Web.

A GUID constant used to specify that the type is a nested hierarchy project.

A GUID constant used to specify that the type is a non-physical folder.

A GUID constant used to specify the debug pane inside the output window.

The GUID of the pseudo service that returns the General output pane in the VS environment.

A Visual Studio component selector page GUID.

GUID of the Text editor factory.

String resource ID for Visual Studio pseudo-folder.

This GUID identifies the standard set of commands known by Visual Studio 97 (version 6).

The GUID for the highest abstraction task lists.

The GUID for a certain flavor or task lists.

A GUID that defines the command group related to the hierarchy window.

GUID of the IUnknown COM interface.

cmdidOpenWith handlers should pass this value to the method to get the Open With dialog, in this case on possible Code Views.

cmdidOpenWith handlers should pass this value to the method to get the Open With dialog, in this case populated with possible debugging views which map to the same view as .

cmdidOpenWith handlers should pass this value to the method to get the Open With dialog, in this case to View Form designer views.

cmdidOpenWith handlers should pass this value to method to get the Open With dialog, in this case the default/primary view of the editor factory.

cmdidOpenWith handlers should pass this value to method to get the Open With dialog, in this for a document or data text editor view.

cmdidOpenWith handlers should pass this value to method which prompts the user to choose which user-defined view to use.

A legacy OLE error.

The user was prompted to save but chose the Cancel button from the prompt message box.

The cache is for a static object and it already has a cache node.

The versions of COMPOBJ.DLL and OLE2.DLL on your machine are incompatible with each other.

Describes what component of the shell has just been selected.

HRESULT for false.

Generic HRESULT for success.

The name of the Visual Studio service that implements .

Returns an IID_IVsOutputWindowPane interface of the General output pane in the Visual Studio environment.

A Visual Studio toolbox service.

A constant referenced in selection events to describe which component of the shell has just been selected, in this case in response to project startup.

Returns the GUID of the command associated with a change in UI context.

Specifies that UI context is the switch to a debugging window.

Returns the GUID of the command associated with a change to design mode in UI context.

Returns the GUID of the command associated with the UI drag/drop operation.

Packages may define a command that is associated with a change in UI context. Use UICONTEXT_EmptySolution to return the GUID of the command associated with this UI state. In this case the UI context is an empty solution.

Packages may define a command that is associated with a change in UI context. Use UICONTEXT_FullScreenMode to return the GUID of the command associated with this UI state. In this case the UI context is that the Full Screen command from the View menu has been selected.

Packages may define a command that is associated with a change in UI context. Use UICONTEXT_NoSolution to return the GUID of the command associated with this UI state. In this case the UI context is that there is no solution.

Packages may define a command that is associated with a change in UI context. Use UICONTEXT_SolutionBuilding to return the GUID of the command associated with this UI state. In this case the UI context is Build solution or build project mode is in effect.

Packages may define a command that is associated with a change in UI context. Use UICONTEXT_SolutionExists to return the GUID of the command associated with this UI state. In this case the UI context is that a solution exists, though the number of projects loaded is not pertinent to this call.

Packages may define a command that is associated with a change in UI context. Use UICONTEXT_SolutionHasMultipleProjects to return the GUID of the command associated with this UI state. In this case the UI context is that a solution exists and has multiple projects loaded.

Error HRESULT for a client abort.

A constant referenced in selection events to describe which component of the shell has just been selected.

A constant returned by interfaces to asynchronous behavior when the object in question in already busy.

A Visual Studio specific error HRESULT for "Incompatible document data".

A Visual Studio specific error HRESULT that indicates "Package not loaded."

A Visual Studio-specific error HRESULT that indicates that the "Project already exists."

A Visual Studio specific error HRESULT that indicates "Project configuration failed."

A Visual Studio-specific error HRESULT that indicates "Project not loaded."

A Visual Studio-specific error HRESULT that indicates "Solution already open."

A Visual Studio-specific error HRESULT that indicates "Solution not open."

Returned by build interfaces that have parameters for specifying an array of IVsOutput's but the implementation can only apply the method to all outputs.

returns this value if the document has a format that cannot be opened in the editor.

An HRESULT value that indicates that the user hit the back button in a Visual Studio wizard.

A Visual Studio-specific error HRESULT that indicates "Project forwarded."

A Visual Studio-specific constant for a "Toolbox marker."

A Visual Studio-specific constant that indicates that a cookie has not been set.

A Visual Studio item identifier that represents the absence of a project item. This value is used when there is no current selection.

A Visual Studio item identifier that represents the root of a project hierarchy and is used to identify the entire hierarchy, as opposed to a single item.

A Visual Studio item identifier that represents the currently selected item or items, which can include the root of the hierarchy.

A Visual Studio-specific constant for broadcasting a notification message via that indicates the beginning of modality.

A Visual Studio-specific constant for broadcasting a notification message via that indicates the end of modality.

A Visual Studio-specific constant for broadcasting a notification message via indicating that the command bar metrics have changed.

GUID for the Windows 2000 command set. This is a set of standard editor commands.

A constant referenced in selection events to describe which component of the shell has just been selected.

Constants used in to indicate a new selection state. The selections may be propagated through .

Visual Studio tracks this selection automatically so it cannot be set via , but the value may be observed by calling

The value of before it received its current value. It is guaranteed to be different from unless both are empty.

of the active .

of the active for list navigation commands.

of the active StartupProject.

of the active object.

An event that indicates selection only by document windows that do not push selection context to the property browser. The alternative case is .

Visual Studio tracks this selection automatically so it cannot be set via , but the value may be observed by calling

These constants make some basic menu commands available to managed code.

Activate Filter

Delete Backwards; Delete the current selection, or if no selection, the previous character.

Tab Left; Move the caret back one tab stop.

Line Start; Move the caret to the start of the line.

Line Start Extend; Move the caret to the start of the line, extending the selection.

Line Start Extend Column; Move the caret to the start of the line, extending the column selection.

View Bottom; Move the caret to the last line in view.

View Bottom Extend; Move the caret to the last line in view, extending the selection.

Selection Cancel; Cancel the current selection moving the caret to the anchor point.

Comment Block; Comment out the selected block.

Complete Word; Display Word Completion based on the current language.

Copy; Copy the current selection to the clipboard.

Cut; Cut the current selectionto the clipboard.

Line Cut; Cut all selected lines, or the current line if no selection, to the clipboard..

Delete; Delete the current selection.

Clear Bookmarks; Clear all unnamed bookmarks in the current document.

Delete Blank Lines; Delete all blank lines in the selection, or the current blank line if no selection.

Delete Line; Delete all selected lines, or the current line if no selection.

Delete To BOL; Delete from the caret position to the beginning of the line.

Delete To EOL; Delete from the caret position to the end of the line.

Delete Horizontal White Space; Collapse white space in the selection, or delete white space adjacent to the caret if no selection.

Word Delete To Start; Delete the word to the left of the caret.

Word Delete To End; Delete the word to the right of the caret.

Double Click.

Line Down; Move the caret down one line.

Line Down Extend; Move the caret down one line, extending the selection.

Line Down Extend Column; Move the caret down one line, extending the column selection.

Document End; Move the caret to the end of the document.

Document End Extend; Move the caret to the end of the document, extending the selection..

Line End; Move the caret to the end of the line..

Line End Extend; Move the caret to the end of the line, extending the selection.

Line End Extend Column; Move the caret to the end of the line, extending the column selection.

Externally handled widget click;A mouse click event in the widget margin passed to an external handler. The widget margin is used to set breakpoints or bookmarks.

Find; Find the occurance.

Find Again; Repeat the find operation.

Find Next; Find the next occurance

Find Next Word; Find the next occurance of word.

Find Prev; Find the previous occurance

Find Prev Word; Find the previous occurance of word.

Line Start After Indentation; Move the caret to first non-white space character on the line.

Line Start After Indentation Extend; Move the caret to first non-white space character on the line, extending the selection.

Line Start After Indentation Next; Move the caret to the first non-white-space character on the next line.

Line Start After Indentation Next; Move the caret to the first non-white-space character on the previous line.

Format Selection; Format the currently selected text.

Go Back; Go back one character.

Goto Brace; Move the caret forward to the matching brace.

Goto Brace Extend; Move the caret forward to the matching brace, extending the selection.

Go To Line; Go to the indicated line.

Next Bookmark; Move the caret to the next unnamed bookmark.

Previous Bookmark; Move the caret to the previous unnamed bookmark.

Help Keyword

Document Start; Move the caret to the start of the document.

Document Start Extend; Move the caret to the start of the document, extending the selection.

Increase Line Indent; Increase Indent.

Insert File As Text; Insert a file into the current document.

Incremental Search; Reverse Incremental Search.

Reverse Incremental Search.

Line Last Char; Move the caret after the last non-white space character on the line.

Line Last Char Extend; Move the caret after the last non-white space character on the line, extending the selection..

Char Left; Move the caret left one character..

Char Left Extend; Move the caret left one character, extending the selection..

Char Left Extend Column; Move the caret left one character, extending the column selection.

Open URL; Invoke the default browser and opens the URL under the caret.

Open File; Open file under caret.

Line Open Above; Open a new line above the current line..

Line Open Below: Open a new line below the current line..

Open URL; Invoke the default browser and opens the URL under the caret..

Collapse to Definitions; Outline Collapse To Definitions.

Hide Selection; Outline Hide Selection.

Stop Outlining; Outline Stop Hiding All.

Stop Hiding Current; Outline Stop Hiding Current.

Toggle All Outlining; Toggle all hidden regions.

Toggle Outlining Expansion; Outline Toggle Current.

Page Down; . Move the caret down one page.

Page Down Extend; Move the caret down one page, extending the selection.

Page Up; Move the caret up one page.

Page Up Extend; Move the caret up one page, extending the selection.

Parameter Info; Display Parameter Info based on the current language.

Paste; Paste the selection.

Quick Info; Display Quick Info based on the current language.

Redo; Repeat the operation.

Replace; Replace the occurance.

Replace All; Replace all instances of the occurance.

Break Line; Insert a line break at the current caret position.

Char Right; Move the caret right one character.

Char Right Extend; Move the caret right one character, extending the selection.

Char Right Extend Column; Move the caret right one character, extending the column selection.

Scroll Line Bottom; Scroll the current line to the bottom of the view.

Scroll Line Center; Scroll the current line to the center of the view.

Scroll Line Down; Scroll the document down one line.

Scroll Column Left; Scroll the document left one column.

Scroll Page Down: Scroll the document down one page.

Scroll Page Up: Scroll the document up one page..

Scroll Column Right; Scroll the document right one column.

Scroll Line Top: Scroll the current line to the top of the view.

Scroll Line Up: Scroll the document up one line.

Select All; Select all of the document.

Select Current Word; Select the word under the caret.

Select Mode; Toggle the selection mode.

Make Lowercase; Change the text in the current selection to all lower case.

Swap Anchor; Swap the anchor and end points of the current selection.

Tabify Selection: Replace spaces in the current selection with tabs.

Capitalize; Capitalize the first letter of words in the selection.

Toggle Case: Toggle the case of the text in the current selection.

Untabify Selection; Replace tabs in the current selection with spaces.

Make Uppercase; Change the text in the current selection to all upper case.

Displays a context menu. If unhandled this most editors display a default context menu without any language-specific commands. If you want your own commands on this menu, handle the command and bring up a context menu yourself.

Show Member List; Display an object Member List based on the current language.

Insert Tab; Insert a tab character at the current caret position.

Overtype Mode; Toggle between insert and overtype insertion modes.

Paste Moves Caret; Toggle where the caret is positioned after a paste operation.

Toggle Task List Shortcut; Toggle a task list shortcut on the current line.

Toggle Bookmark; Toggle an unnamed bookmark on the current line.

View White Space; Toggle the visibility of white space characters.

Toggle Word Wrap; Toggle Word Wrap mode.

View Top; Move the caret to the top line in view.

View Top Extend; Move the caret to the top line in view, extending the selection.

Char Transpose: Transpose the characters on either side of the caret.

Line Transpose; Transpose the current line and the line below.

Word Transpose; Transpose the words on either side of the caret.

Uncomment Selection; Uncomment the selected lines.

Uncomment Block; Uncomment the selected block. If the block is not commented, make no change.

Undo; Undo the last operation.

Decrease Line Indent; Line Unindent.

Line Up.

Line Up Extend; Move the caret up one line, extending the selection.

Line Up Extend Column; Move the caret up one line, extending the column selection.

Widget Margin Left Button Down; A left button down event in the widget margin. The widget margin is used to set breakpoints or bookmarks.

Word Next; Move the caret right one word.

Word Next Extend; Move the caret right one word, extending the selection.

Word Next Extend Column; Move the caret right one word, extending the column selection..

Word Previous; Move the caret left one word..

Word Previous Extend; Move the caret left one word, extending the selection..

Word Previous Extend Column; Move the caret left one word, extending the column selection.

These constants make some basic menu commands available to managed code.

Command id for "close solution".

Command id for "copy".

Command id for "cut".

Command id for "delete".

Command id for "exit".

Command id for "file close".

Command id for "file new".

Command id for "file open".

Command id for "find".

Command id for "go to".

Command id for "new project".

Command id for "open project".

Command id for "open solution".

Command id for "page setup".

Command id for "paste".

Command id for "print".

Command id for "print preview".

Command id for "redo".

Command id for "replace".

Command id for "save".

Command id for "save as".

Command id for "save options".

Command id for "save project item as".

Command id for "save solution".

Command id for "save solution as".

Command id for "select all".

Command id for "tools options".

Command id for "undo".

An enumeration of commands that apply to events unique to the .

Occurs when the user hits the escape key and causes an editable tree node to turn back into static text.

Occurs when a tree node turns from an editable entry field back into static text.

Occurs when the user double clicks the mouse on the tree's pane.

Occurs when the user hits the Enter key while the tree's pane has focus.

Occurs when the user right clicks the mouse over the tree's pane.

Occurs when tree node text becomes an editable entry field.

Imports some Win32 window management functions.

Initializes a new instance of the class.

Determines if a message is intended for the specified dialog box, and if so processes the message.

true if the message has been processed, otherwise false. The message in question. A handle to the child window.

Changes the parent window of the specified child window.

If the function succeeds, a handle to the previous parent window, otherwise null. A handle to the new parent window. A handle to the child window that should receive a new parent.

Defines the default registry root used to register VSPackage information. This class cannot be inherited.

Initializes a new object with the given registry root.

The default registry root used to register VSPackage information. The constructor throws an if the root argument is null.

Gets the value of the default registry root for the VSPackage.

The value of the default registry root for the VSPackage.

A specialization of that allows customization of the display name of the property in the property grid.

Initializes a new instance of for the specified property descriptor.

Determines whether or not resetting the object changes its value.

true if resetting the component changes its value, otherwise false. The component that owns the property.

Gets an editor of the specified type.

The editor, or null if it cannot be found. The type of the editor.

Converts the name to a .

. The name of the type.

Gets the value of the property.

The value of the property. The component that owns the property.

Resets the value to the default value.

The component that owns the property.

Sets the value of the property to the specified value.

The component that owns the property. The value to set.

Determines whether or not the property's value should be persisted.

true if the property should be persisted, otherwise false. The component that owns the property.

Gets the component type.

The type of the component.

Gets the type converter for the property.

Gets the display name for this property.

The display name.

Gets whether or not the property is read-only.

true if the property is read-only, otherwise false.

Gets the type of the property.

The type of the property.

Use this class to implement modal forms in Visual Studio. The implementation enables the form to host a Visual Studio command bar so that it participates in standard command routing.

Initializes a new instance of the class.

Initializes a new instance of the class and sets the service provider.

The service provider that the window can subsequently query to retrieve Visual Studio services.

Initializes a new instance of the class and sets the service provider as well as the control contained by the form.

The service provider that the window can subsequently query to retrieve Visual Studio services. The control contained by the form.

Initializes a new instance with its contained control and an additional implementation in addition to the one owned by the .

The . The that is to be contained. The parent .

Explicitly called to release resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Stores toolbar information and resizes the main pane to leave room for the command bar.

If the method succeeded, , otherwise an error code. The new desired bounds.

Sets the site for this window.

The service provider.

Shows a dialog.

Gets the service of the specified type.

An object representing the requested service. The type of service requested.

Filters mouse messages before they are dispatched.

true if the message was filtered and not dispatched, false if it was dispatched. A message from the toolbar.

Returns the command service used to check the status or execute the toolbar's commands.

Returns the corresponding .

Gets or sets the command ID of the toolbar contained in this dialog.

The command ID of the toolbar contained in this dialog.

Gets and sets the value of the enumeration that describes the toolbar location.

The enumeration is defined as:typedef enum {VSTWT_LEFT, VSTWT_TOP, VSTWT_RIGHT, VSTWT_BOTTOM} VSTWT_LOCATION;Which corresponds to toolbar locations of left, top, right and bottom.

Provides a standard dialog functionality for implementing Toolbox property sheets, ToolsOptions pages, or custom UI dialog boxes with support for the Visual Studio automation model, Windows Forms, and state persistence through the Visual Studio settings mechanism.

Initializes a new instance of .

Releases the unmanaged resources used by a dialog page class and optionally releases the managed resources; the parent class, supports unmanaged resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Called by Visual Studio to load a dialog page's settings from local storage, generally the registry.

Called by Visual Studio to load a dialog page's settings from the Visual Studio settings storage on disk.

[in]An interface provided by the environment to the VSPackage providing read access to the Visual Studio settings file.

Handles Windows Activate messages from the Visual Studio environment.

[in] Arguments to event handler.

Handles Apply messages from the Visual Studio environment.

[in] Arguments to event handler.

Handles Close messages from the Visual Studio environment.

[in] Arguments to event handler.

Handles Deactive messages from the Visual Studio environment.

[in] Arguments to event handler.

This method should be overridden to reset settings to their default values.

Called by Visual Studio to store a dialog page's settings in local storage, generally the registry.

Called by Visual Studio to store a dialog page's settings to the Visual Studio settings storage on disk.

[in]A interface provided by the environment to the VSPackage providing write access to the Visual Studio settings file.

Gets the DTE automation model object for a given instance of a dialog page class.

An instance of the automation object, or null if no automation support is available.

Gets or sets the sub-key under the Visual Studio version-specific root for storing settings data for a dialog page.

The sub-key of the Visual Studio version-specific registry tree containing the settings for a given dialog page.

Gets or sets the site of the dialog page. Overrides the implementation inherited from .

Gets the handle of the window of the dialog page.

A pointer that is the handle of an .

Gets the window that is used as the user interface of the dialog page.

An providing the handle to the window acting as the user interface for dialog page.

An enumeration that describes dialog page apply behavior.

Allows the changes to be applied

Cancels the apply event and navigates to the page cancelling the event.

Cancels the apply event and returns the active page, not the page canceling the event.

Event arguments that allow the method to indicate how to handle the apply event.

Initializes a new instance of .

Gets or sets the kind of behavior that should take plan on Apply.

This task provider is used to provide tasks for the Visual Studio Error List window.

Creates an ErrorListProvider object.

object.

Activates the Error List window and makes it visible.

Parameter is set to true if the task list can be disposed, that is, if the contains tasks.

Destructor for ErrorListProvider.

Shows the errors in the Error List window.

Creates a Error List tool window and shows the errors in it.

Returns the service that allows VSPackage implementers to store and manage their tasks as a part of the environment's task list.

Returns an object.

Represents an error task on the Task List. This class implements .

Initializes a new instance of an .

Initializes a new instance of an for the specified error.

Gets the category of the error.

. [out] Returns the .

Gets the hierarchy node associated with the task.

. [out] Returns the interface of the node associated with this task.

Gets or sets the error category of this task.

Gets or sets the hierarchy item associated with this task.

The item associated with the task.

Maps objects to and from event "cookies" that represent a client's registration with an event provider.

Initializes a new instance of an object.

Adds an event and returns its cookie.

The cookie of the added event. An object to be added to the event collection.

Removes all event cookies.

Removes the specified event cookie from the collection.

The event cookie to be removed.

Removes the event cookie.

The event cookie.

Updates the event associated with the given cookie.

A cookie specifying an event. The value to which the event sink is set.

Microsoft Internal Only.

Returns an .

Gets the total number of event cookies in the collection.

The number of cookies in the collection.

Gets or sets the specified cookie from the collection.

The cookie. The cookie to get.

Provides the ability to configure objects dynamically by adding additional data to the toolbox item's Properties dictionary. This data is then serialized as a permanent part of the toolbox item.

Called by the toolbox service to configure objects.

[in] The object whose configuration is to be modified.

Provides information for the Visual Studio splash screen and the Help About dialog box when applied to a -derived class or a class that implements . This class cannot be inherited.

Initializes a new InstalledProductRegistrationAttribute instance for the specified product.

The name of the product. The product ID. true if the package implements the interface to collect and display the information, otherwise false. The detailed description of the product.

Registers information about a VSPackage when called by an external registration tool such as regpkg.exe.

A provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered. context is null.

Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe.

A provided by an external registration tool. The context can be used to remove registry keys, log registration activity, and obtain information about the component being registered.

Gets or sets the resource ID of the icon associated with the product.

The resource ID of the icon associated with the product.

Gets or sets the (non-localized) name of the product.

The (non-localized) name of the product.

Gets or sets the detailed description of the product.

The detailed description of the product.

Gets or sets the product details resource ID.

The product details resource ID.

Gets or sets the product ID.

The ID of the product.

Gets or sets the name of the product.

The name of the product.

Gets or sets the resource ID of the product name.

The product name resource ID.

Gets or whether the package implements the interface to display a bitmap in the splash screen and information in the About dialog box on the Help menu.

The value is true if the product installation implements the interface and false otherwise.

Gets or sets whether the product installation uses the package ID.

The value is true if the product installation uses the package ID, and false otherwise.

Interface implemented by classes supporting VSPackages by persisting their state information through the Visual Studio settings mechanism.

Reads a VSPackage's configuration from local storage (typically the registry) and updates its state.

Writes a VSPackage's configuration to disk using the Visual Studio settings mechanism when the export option of an Import/Export Settings feature available on the IDE’s Tools menu is selected by a user.

[in] An interface provided by the environment to the VSPackage providing read access to the Visual Studio settings file.

Resets the user settings.

Writes a VSPackage's configuration to local storage (typically the registry) following state update.

Writes a VSPackage's configuration to disk using the Visual Studio settings mechanism when an import option of the Import/Export Settings command on the IDE’s Tools menu is selected by a user.

[in] An interface provided by the environment to the VSPackage providing write access to the Visual Studio settings file.

An abstraction layer that lets clients control the resx readers and writers used within Visual Studio.

Returns a resx resource reader that matches a given a resXFullName.

. Creates a reader for the specified file. If this value is true the reader returns one or more s instead of the object type the resource becomes at runtime in order to figure out which files the resx references

Returns a resx resource reader given a basepath and name.

. If this value is true the reader returns one or more s instead of the object type the resource becomes at runtime in order to figure out which files the resx references The path of the resource file. The that is wrapped by the returned .

Returns a resx resource writer given resXFullName.

. Creates a reader for the specified file.

Returns a resx resource writer given a textWriter and basepath.

. The that is wrapped by the returned . The path of the resource file.

provides a class that supplies custom type information on localizable properties for an object.

This default constructor creates a object.

Returns a wrapper on the given property descriptor.

Returns a . Property descriptor.

Gets a collection of attributes for this component.

Returns a collection of attributes.

Returns the class name of this object.

A string containing the class name.

Returns the name of this object.

A string containing the component name.

Returns a type converter for this object.

Returns a .

Returns the default event for this object.

Returns an .

Gets the default property for a component.

Returns a .

Retrieves the editor for this object.

Returns the editor object. A that represents the base type of the editor you want to find.

Gets the collection of events for a specified component.

An with the events for this component.

Gets the collection of events for a specified component using a specified array of attributes as a filter.

An with the events that match the specified attributes for this component. An array of type to use as a filter.

Gets the collection of properties.

Returns a .

Returns the properties for selected object using the attribute array as a filter.

Returns a . An array of type to use as a filter.

Returns the brows-able object.

Returns the browsable object. object.

Specifies the localizable display name for a property, event, or public void method which takes no arguments.

Initializes a new instance of for the specified name.

The name to localize.

Gets the localized display name.

The localized display name.

This enumeration lists the supported logical views.

The corresponding GUID value is FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF.

The corresponding GUID value is 7651A701-06E5-11D1-8EBD-00A0C90F26EA.

The corresponding GUID value is 7651A700-06E5-11D1-8EBD-00A0C90F26EA.

The corresponding GUID value is 7651A702-06E5-11D1-8EBD-00A0C90F26EA.

The corresponding GUID value is 00000000-0000-0000-0000-000000000000.

The corresponding GUID value is 80A3471A-6B87-433E-A75A-9D461DE0645F.

The corresponding GUID value is 7651A703-06E5-11D1-8EBD-00A0C90F26EA.

The corresponding GUID value is 7651A704-06E5-11D1-8EBD-00A0C90F26EA.

Defines the Windows Installer component ID. The component ID is used by the Windows Installer to indicate the installation path to the VSPackage.

This constructor creates a new MsiComponentIdAttribute object.

The Windows Installer component ID. The MSI component registration ID is used to indicate the installation path to the component within the Windows Installer.

The Id property returns a string containing the Windows Installer component registration ID.

Returns a string containing the Windows Installer component registration ID.

Defines a token string for the MSI installer.

Creates an MsiTokenAttribute object.

Name of the MsiTokenAttribute. Value of the MsiTokenAttribute.

Returns the MsiTokenAttribute name.

Returns a string containing the MsiTokenAttribute name.

Returns the MsiTokenAttribute value.

Returns a string containing the MsiTokenAttribute value.

Provides a managed class that implements the IOleDataObject interface.

Initializes a new instance of .

Initializes a new instance of for the specified object implementing .

The underlying .

Initializes a new instance of for the specified .

The underlying .

Initializes a new instance of for the specified .

The underlying .

Establishes a connection between the data object and a caller object implementing .

If the method succeeded, , otherwise an error code. Pointer to a FORMATETC structure that defines the format, target device, aspect, and medium that will be used for future notifications. For example, one sink may want to know only when the bitmap representation of the data in the data object changes. Another sink may be interested in only the metafile format of the same object. Each advise sink is notified when the data of interest changes. This data is passed back to the advise sink when notification occurs. Pointer to a DWORD token that identifies this connection. You can use this token later to delete the advisory connection (by passing it to . If this value is zero, the connection was not established. Pointer to the interface on the advise sink that will receive the change notification. DWORD that specifies a group of flags for controlling the advisory connection. Valid values are from the enumeration ADVF. However, only some of the possible ADVF values are relevant for this method.

Terminates an advise connection previously established through .

DWORD token that specifies the connection to remove. Use the value returned by when the connection was originally established.

Creates an enumerator to iterate through the current advisory connections.

If the method succeeded, , otherwise an error code. Address of * pointer variable that receives the interface pointer to the new enumerator object. If the implementation sets *ppenumAdvise to NULL, there are no connections to advise sinks at this time.

Creates an enumerator to iterate through the structures supported by the data object.

If the method succeeded, , otherwise an error code. Direction of the data through a value from the enumeration . Address of * pointer variable that receives the interface pointer to the new enumerator object.

Retrieves a structure that is logically equivalent to one that is more complex.

If the method succeeded, , otherwise an error code. Pointer to a structure that contains the most general information possible for a specific rendering, making it canonically equivalent to pFormatetcIn. Pointer to the structure that defines the format, medium, and target device that the caller would like to use to retrieve data in a subsequent call such as . The TYMED member is not significant in this case and should be ignored.

Transfers data from the data object to the client. The pformatetcIn parameter must specify a storage medium type of .

Pointer to the STGMEDIUM structure that indicates the storage medium containing the returned data through its tymed member, and the responsibility for releasing the medium through the value of its punkOuter member. Pointer to the structure that defines the format, medium, and target device to use when passing the data.

Similar to , except the client must allocate the structure.

Determines whether the data object supports a particular structure for transferring data.

If the method succeeded, , otherwise an error code. Pointer to the structure that defines the format, medium, and target device to use when passing the data. Only one medium can be specified in the tymed member of the FORMATETC structure. These values are valid:TYMED_STORAGETYMED_STREAMTYMED_HGLOBALTYMED_FILE

Transfers data from the client to the data object.

Pointer to the structure that defines the format, medium, and target device to use when passing the data. Only one medium can be specified in the tymed member of the FORMATETC structure. These values are valid:TYMED_STORAGETYMED_STREAMTYMED_HGLOBALTYMED_FILE Pointer to the structure that defines the storage medium containing the data being transferred. The medium must be allocated by the caller and filled in by . The caller must also free the medium. The implementation of this method must always supply a value of NULL for the punkForRelease member of the STGMEDIUM structure to which this parameter points. If TRUE, the data object called, which implements , owns the storage medium after the call returns.

The set of arguments passed to an object when the function is called.

Initializes a new instance of the specified in and out parameters.

The input parameters to the command function. A pointer to the parameter returned by the function.

Gets the in parameters to the command.

The in parameters to the command.

Gets a pointer to the parameter used as output by the command function.

A pointer to the out parameter.

This class is an expansion of the class.

Initializes a new instance of for the specified command.

The event handler called to execute the command. ID of the command.

Initializes a new instance of for the specified command.

The text of the command. The event handler called to execute the command. ID of the command.

Initializes a new instance of for the specified command with the specified invocation and status handlers.

The event handler called when the command's status changes. The event handler called to execute the command. ID of the command.

Initializes a new instance of for the specified command with the specified invocation and status handlers.

The text of the command. The event handler called when the command's status changes. The event handler called to execute the command. ID of the command.

Initializes a new instance of for the specified command with the specified pre-QueryStatus, invocation, and status handlers.

Event handler called when a client requests the command status. The event handler called when the command's status changes. The event handler called to execute the command. ID of the command.

Initializes a new instance of for the specified command with the specified pre-QueryStatus, invocation, and status handlers.

The text of the command. Event handler called when a client requests the command status. The event handler called when the command's status changes. The event handler called to execute the command. ID of the command.

Called when a client requests the status of the command.

Allows a dynamic item command to match the subsequent items in its list.

true if the dynamic item found a match, otherwise false. The command ID.

Executes the command.

The parameter passed to the command.

Executes the command.

The parameter returned by the command. The parameter passed to the command.

Gets or sets a the command ID.

The command ID that was most recently used to match this command.

Gets the OLE command status code for this menu item.

The status flags that reflects the state of this menu item.

Gets or sets the description of the parameters of the command.

The description of the parameters of the command.

Gets or sets the text for the command.

The text for the command.

This class derives from the class and implements . is the managed class used to add handlers for menu commands and to define verbs.

Creates a new menu command service.

The service provider that this service uses to obtain other services. If the service is being used with a designer, this should be the service provider for the designer (such as the instance).

Creates a new menu command service.

The service provider that this service uses to obtain other services. If the service is being used with a designer, this should be the service provider for the designer (such as the instance). Allows the service to defer command searching to a parent IOleCommandTarget if the command is not found in this object. Throws an if parentCommandTarget is null.

Can be used to invoke any command within Visual Studio.

true if the invocation succeeded; otherwise, false. The command ID of the command to search for and execute.

Can be used to invoke any command within Visual Studio.

true if the invocation succeeded; otherwise, false. The optional command argument. The command ID of the command to search for and execute.

Executes the selected command.

An HRESULT code indicating the success or failure of the call. The following HRESULTs may be returned:ValueDescriptionThe command was successfully invoked.The group guid did not match the commandID’s Guid property for any command or verb.The group was found, but there is no command or verb with an ID that matches. This is also returned if the OleStatus property of a command that was found returns zero. System.UInt32 nCmdId. The ID code of the command. This implementation maps nCmdId to CommandID.ID. System.Guid guidGroup. The menu group. This implementation maps the group to CommandID.Guid. System.Object[] pIn. Actual command options. This implementation ignores this parameter. System.UInt32 nCmdExcept. Count of command options. This implementation ignores this parameter. System.IntPtr vOut. Output data for the command. This implementation ignores this parameter.

Sets command status.

An HRESULT code indicating the success or failure of the call. The following HRESULTs may be returned:ValueDescriptionThe command was successfully invoked.The group guid did not match the commandID’s Guid property for any command or verb.The group was found, but there is no command or verb with an ID that matches. This is also returned if the OleStatus property of a command that was found returns zero. System.UInt32 nCmdId. The ID code of the command. This implementation maps nCmdId to CommandID.ID. System.Guid guidGroup. The menu group. This implementation maps the group to CommandID.Guid. Microsoft.OLE.Interop._tagOLECMD[] oleCmd. A command structure that contains data about the status of the command. System.IntPtr oleText. A pointer to a text BSTR. If the command is a verb the name of the verb will be filled in here.

Called by a menu command when its status has changed.

Signifies that there has been a change in (added or removed) on the related object.

Shows the shortcut menu with the given command ID at the given location.

The vertical position, in screen coordinates, of the top, left corner of the shortcut menu. If the shortcut menu does not fit on the screen, the operating system relocates it to fit. A command ID representing the shortcut menu to show. The horizontal position, in screen coordinates, of the top, left corner of the shortcut menu. If the shortcut menu does not fit on the screen, the operating system relocates it to fit. menuID is null.

Provides a managed implementation of the VSIP interfaces required to create a fully functional VSPackage.

Initializes a new instance of .

Event generated whenever Visual Studio initializes its Toolbox.

Event generated whenever Visual Studio upgrades its Toolbox.

Adds a user option key name into the list of option keys.

The name of the option key to add. An option key name must not have any periods in it.

Creates the specified COM object using the Visual Studio's local registry CLSID object.

An instance of the created object. The managed type of the object to return. The interface IID the object implements. The CLSID of the object to create.

Enables derived classes to provide an implementation if necessary.

if successful, otherwise an error code. The GUID of the tool window that should be created.

Creates a tool window of the specified type with the specified ID.

An instance of the requested tool window. The type of tool window to create. The tool window ID. This is 0 for a single-instance tool window. toolWindowType is null. id is less than 0.toolWindowType is not derived from type.

Releases the resources used by the object.

true if the object is being disposed, false if it is being finalized.

Gets the tool window corresponding to the specified type and ID.

An instance of the requested tool window. If create is false and the tool window does not exist, null is returned. If true, the tool window is created if it does not exist. The type of tool window to create. The tool window ID. This is 0 for a single-instance tool window. toolWindowType is null. toolWindowType is not derived from .toolWindowType does not have a public constructor that takes a service provider.

Gets the automation object for the VSPackage.

An instance of the automation object, or null if no automation support is available. The name of the automation object to return. If name is null, GetAutomationObject returns the default automation object for the VSPackage. Thrown by the base implementation of GetAutomationObject.

Gets the requested dialog page.

An instance of the requested page. The type of dialog page to retrieve. dialogPageType is null. dialogPageType is not derived from .dialogPageType does not have a public constructor.

Gets a service proffered globally by Visual Studio or one of its packages. This is the same as calling GetService() on an instance of a package that proffers no services itself.

The service being requested if available, otherwise null. The type of the service requested.

Gets the requested output window.

The interface. Returns null in case of failure. The GUID corresponding to the pane. (See class for the GUIDs which correspond to output panes.) The caption to create if the pane does not exist.

Returns the locale associated with this service provider.

Returns the locale identifier for the service provider.

Gets type-based services from the VSPackage service container.

An instance of the requested service, or null if the service could not be found. The type of service to retrieve. serviceType is null.

Called when the VSPackage is loaded by Visual Studio.

Executes a specified command or displays help for a command.

This method returns if it succeeds, otherwise an error code. If no instance of can be found, returns . The ID of the command. The GUID specifying the command group to which the command belongs. A pointer to a VARIANTARG structure containing input arguments. Can be null. A pointer to an structure specifying how the command should be executed. A pointer to a VARIANTARG structure to receive command output. Can be null.

Queries the object for the status of one or more commands generated by user interface events.

if the method succeeded, otherwise an error code. This method returns if no instance of can be found. The ID of the command. The GUID of the command group to which the command belongs. An array of OLECMD structures representing the commands being queried. A pointer to an OLECMDTXT structure in which to return name and/or status information for a single command. Can be null to indicate that the caller does not need this information.

Internal IServiceProvider implementation.

If the method succeeds, it returns , otherwise it returns an error code. GUID of the service. GUID of the requested interface Pointer to the object requested.

Closes and disposes the package.

If the method succeeds, , otherwise an error code.

Gets an automation-friendly object for this package.

If the method succeeds, , otherwise an error code. String containing the automation property name. [out] Returns the automation object.

Proffers access to the Tools menu Options and the property pages of the Customize Toolbox dialog boxes.

If the method succeeds, it returns , otherwise it returns an error code. Unique identifier of the requested property page. Specifies the property page whose values are taken from the structure.

Called to ask the VSPackage if the Visual Studio shell can be closed.

If the method succeeds, it returns , otherwise it returns an error code. Set canClose to false if you want to prevent the shell from closing

Resets Toolbox defaults.

If the method succeeds, it returns , otherwise it returns an error code. Flags whose values are taken from the enumeration

Initializes the VSPackage in the Visual Studio environment.

If the method succeeds, it returns . If it fails, it returns an error code. object.

Loads user options for a given solution.

If the method succeeds, it returns . If it fails, it returns an error code. object. User options whose value is taken from the

Reads user options for a given solution.

If the method succeeds, it returns . If it fails, it returns an error code. object from which the VSPackage should read the user-specific options Name of the stream.

Saves user options for a given solution.

If the method succeeds, it returns . If it fails, it returns an error code. object.

Writes user options for a given solution.

If the method succeeds, it returns . If it fails, it returns an error code. object to which the VSPackage writes the user-specific options. Name of the stream.

Creates a tool window of the specified type with the specified ID.

If the method succeeds, it returns . If it fails, it returns an error code. Type of the window to be created. Instance ID

This method implements the Interface used to manage profiles and import/export settings to XML files.

If the method succeeds, it returns . If it fails, it returns an error code. object. GUID of the page.

Retrieves a VSPackage's configuration using the Visual Studio settings mechanism when a user selects the import option of the Import/Export Settings feature on the IDE’s Tools menu. This method is part of the implementation of the interface used to manage profiles and import/export settings to XML files.

If the method succeeds, it returns . If it fails, it returns an error code. object. true if the Visual Studio IDE must be restarted. Values from the returned by the shell, specifying how the settings are to be processed. GUID of the page.

Invoked by the package class when there are options to be read out of the solution file.

The stream to load the option data from. The name of the option key to load.

Invoked by the class when there are options to be saved to the solution file.

The stream to save the option data to. The name of the option key to save.

Parses an embedded text resource of appropriate format for information about which items should be added to the Toolbox.

The GUID of the VSPackage. A text reader that provides toolbox item data in the format described in Remarks.

Parses an embedded text resource of appropriate format for information about which items should be added to the Toolbox.

A resource manager that provides localized lookup names for the categories provided in the resource data. This parameter can be null, in which case the category names are directly used. A text reader that provides toolbox item data in the format described in Remarks.

Called to ask the package if the shell can be closed.

if the method succeeded, otherwise an error code. [out] Returns true if the shell can be closed, otherwise false.

Registers an editor factory with Visual Studio.

The editor factory to register. factory is null.

Registers a project factory with Visual Studio.

The project factory to register. factory is null.

Displays a specified tools options page.

The options page to open. The options page is identified by the GUID of the optionsPageType object passed in. optionsPageType is null.

Adds the given service to the VSPackage's service container.

Type of service to add. Service object.

Adds the given service to the VSPackage's service container.

that can create the service. This allows a service to be declared as available, but delays creation of the object until the service is requested. Type of service to add.

Adds the given service to the VSPackage's service container.

true if this service should be added to any parent service containers; otherwise, false. Type of service to add. Service object.

Adds the given service to the service container by means of the specified .

true if this service should be added to any parent service containers; otherwise, false. that can create the service. This allows a service to be declared as available, but delays creation of the object until the service is requested. The type of service to add.

Removes the given service type from the service container.

The type of service to remove.

Removes the given service type from the service container, and optionally promotes the removal of the service to parent service containers.

true to promote this request to any parent service containers; otherwise, false. The type of service to remove.

Gets the service of the specified type.

An object representing the requested service, or null if none can be found. The type of the service to get.

Gets the root registry key of the current Visual Studio registry hive.

The root of the Visual Studio registry hive.

Gets the path to user data storage for Visual Studio.

The path to user data storage.

Gets the path to local user data storage for Visual Studio.

The path to local user data storage.

Gets a registry key that can be used to store user data.

A that can be used to store user data.

Gets a value indicating whether the package in the process of shutdown.

true if the package is in the process of shutdown, otherwise false.

Modify your class that implements with this attribute so that the registration tool regpkg.exe will look for additional attributes. For more information, see How to: Register Managed VSPackages.

Initializes an instance of this attribute.

Creates registry entries that correspond to this attribute's value.

Contains information about the entire installation so that registry entries specific to this attribute may be created.

Removes attribute specific registry entries.

Contains information about the entire installation so that registry entries specific to this attribute may be removed.

Gets or sets the method of registration.

Gets or sets the non-default resource .dll location.

The non-default resource .dll location.

Gets or sets whether or not package resources are described in a managed package or in a satellite UI .dll.

Set to true if package resources are described in a managed package, false if they are in a satellite UI .dll.

A set of static utilities for filenames, paths, enumeration/string conversions, images, and other functions.

Determines whether or not a string contains characters that are invalid for file names or paths.

true if the string contains invalid characters, false if the string is a valid file name or path. The file name or path.

Converts a string to an enumeration using a converter.

The enumeration value. The of the string. The string value.

Converts a string to an enumeration type.

The enumeration type. A object describing the culture to use to read localized strings. The value to convert. The enumeration to which the string is to be converted.

Copies the specified file to the local project directory.

The to copy. The local resource to copy it to.

Creates a CAUUID from a GUID array.

A structure. An array of GUIDs.

Creates the directories necessary for the given path.

The path to create.

Creates a list of bitmaps from the resource handle.

An containing a series of bitmaps. The handle of a resource.

Creates an image list from the specified stream.

An containing a series of 16 by 16 pixel bitmaps with a magenta background color. The stream from which to extract the bitmaps.

Creates a list of bitmaps from the specified assembly and resource names.

An containing a series of 16 by 16 pixel bitmaps. The assembly from which to get the resources. An array of resource names (representing bitmaps) in the assembly.

Gets a pointer from a bitmap image.

An integer which serves as an . .

Calculates the distance between two paths.

The relative path. The base . The relative .

Gets the path of system assemblies.

The base directory for system assemblies.

Determines whether or not the specified file name is invalid.

true if the file name is invalid, false if it is valid. The name of the file.

Returns a path for the second file that is relative to the first.

The relative path of the second file. The relative path. The base path.

Returns a relative path if the specified file path is absolute and if it is in the same folder as the URL or in a child folder of the URL.

The relative path to the file. The path to convert. The base URL.

Returns a string from an enumeration value.

A string value derived from the enumeration. The of the string. The enumeration value.

The class representing the attribute describing how to convert property values on property pages in a package. Use this attribute rather than .

Creates a new instance of the class for the specified type.

The type (System.Type) to convert.

The type that is to be converted.

Provides an assembly filter for an object by describing the assemblies such an object supports.

Creates a new instance of a object on the basis of the assembly name provided.

[in] A string containing the full name of an assembly.

The string containing the full assembly specification of the filter.

A string containing the full assembly specification of the filter.

Apply this attribute to your VSPackage class to cause it to be automatically loaded when a specified UI context is active. This class cannot be inherited.

Returns a new instance of this attribute with the specified cmdUiContextGuid.

The GUID of the command context which will cause this package to load.

Provides registration information about a VSPackage when called by an external registration tool like regpkg.exe.

A registration context provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered.

Removes registration information about a VSPackage when called by an external registration tool like regpkg.exe.

Returns the UI context GUID which will cause your package to load.

The UI context GUID.

Modifying your -derived class with this attribute declares that it provides a particular automation object.

Initializes a new instance of .

The name of the automation object.

Registers this attribute when called by an external registration tool such as RegPkg.exe.

A provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered.

Removes the registry key when called by an external registration tool such as RegPkg.exe.

A provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered.

Gets or sets the description of the automation object.

The description of the automation object.

Gets the name of the automation object.

The name of the automation object.

Associates a file extension to a given editor factory when applied to a class that inherits from or implements the interface .

Initializes an instance of ProvideEditorExtensionAttribute.

One of following types:The type of the editor factory expressed as a string.The GUID of the editor factory.The type of the editor factory. The priority of this editor factory. The editors with the higher priority number is given a chance to read a file first. Upon failure, the next editor in priority is used. The file extension to associate with the editor factory. This extension should include the prefix “.”.

Called to register this attribute with the given context. The context contains the location where the registration information should be placed. It also contains the type being registered and path information.

Removes the registration information about a VSPackage when called by an external registration tool such as RegPkg.exe. For more information, see How to: Register Managed VSPackages.

Gets or sets the default name of the editor.

The default name of the editor.

Gets or sets the value that determines whether or not the EditorFactoryNotify registry key should be created.

true if the EditorFactoryNotify registry key should be created, otherwise false.

Gets the file extension associated with this editor.

The file extension for this editor.

Returns the GUID of the associated factory.

The GUID of the editor factory.

Gets and sets the integer NameResourceID.

Name resource ID.

Gets the editor's priority as set in the constructor.

The priority for this editor for its file extension.

Sets and gets the GUID of the project associated with this editor.

The project GUID.

Gets or sets the template directory to be used by the editor factory to retrieve its source files.

The template directory.

This attribute declares that the VSPackage provides an editor factory.

This constructor creates a new object.

The object type that implements . The resource ID in the unmanaged resource file that contains the localized name of the editor factory.

Called to register this attribute with the given context.

. Contains the location where the registration information should be placed, and also contains information about the editor type being registered, and path information.

Called to un-register this attribute with the given context.

. Contains the location where the registration information should be placed, and also contains information about the editor type being registered, and path information.

Gets the editor factory type.

The editor factory type.

Gets resource ID.

Returns the editor factory esource ID specified in the resource file.

Gets or sets the trust level for the editor.

Adds a logical view to the editor created by an editor factory.

Initializes a new instance of for the specified factory type and logical view.

The type of factory. This may be a type, a GUID or a string representation of a GUID The GUID of the logical view to register.

Registers this attribute with the given context.

. The context contains the location where the registration information should be placed. It also contains other information such as the type being registered and path information.

Unregisters the logical view.

. The context contains the location where the registration information should be placed. It also contains other information such as the type being registered and path information.

Gets the GUID of the factory type.

The GUID of the factory type.

Gets or sets the trust flag for this logical view.

true if the logical view is trusted, otherwise false.

Gets the GUID of the logical view.

The GUID of the logical view.

Provides an extender for Visual Studio. This class cannot be inherited.

Initializes a new instance of for the specified extender.

The CATID of the element to be extended. The GUID of the extender. The name of the extender.

Provides registration information about a VSPackage when called by an external registration tool such as RegPkg.exe.

A provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered.

Removes registration information about a VSPackage when called by an external registration tool such as RegPkg.exe.

A provided by an external registration tool. The context can be used to remove registry keys, log registration activity, and obtain information about the component being registered.

Gets the GUID category ID of the element to be extended.

The GUID category ID of the element to be extended.

Gets the GUID of the extender.

The GUID of the extender.

Gets the name of the extender.

The name of the extender.

Provides a key binding table GUID. By putting this attribute on your -derived class or class that implements you will declare that it has the given key binding (KEYBINDINGS_SECTION – KEYBINDINGS_END) table in its Command Table Configuration (.ctc) File.

Initializes a new instance of for the specified table and name resource ID.

The GUID of the key binding table in the Command Table Configuration (.ctc) File. The resource ID in the unmanaged resource file that contains the localized name of the key binding table.

Called to register this attribute with the given context.

A provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered.

Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

A provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered.

Gets or sets whether the user is allowed to bind new commands to navigation keys.

true if the user is allowed to bind new commands to navigation keys, otherwise false.

Gets the name resource ID.

The name resource ID

Gets the GUID of the key binding table.

The GUID of the key binding table.

Registers language service support for code snippets.

Initializes a new instance of the class.

[in] A string containing the path to the code snippets index file for the language. [in] The name of the language. This name is used in the registry for registry key and entry names. [in] The resource ID for the localized version of the language name. This is used to present the language name in dialog boxes and other user interface elements. [in] A string containing an identifier specific to the language that is used to mark and identify code snippets. [in] This is either a string containing a GUID or a type representing the class that implements the language service. The language service GUID is derived from this string or type.

Creates all of the registry keys and entries as specified by the class constructor.

[in] A object used to manage registry keys.

Removes all of the registry keys and entries as specified by the class constructor.

[in] A object used to manage registry keys.

Gets or sets a semicolon-delimited string containing the directory or directories that should be created.

The directory or directories that should be created.

Gets the name of the language.

The name of the language.

Gets the GUID of the language service.

The GUID of the language service.

Gets or sets a semicolon-delimited string containing the default paths to search for snippets.

Returns a semicolon-delimited string containing the paths to search for snippets.

Gets or sets whether or not the roots of the code snippets should be shown.

true if the roots should be shown, otherwise false.

Informs Visual Studio about a language service property page.

Initializes a new instance of for the specified page.

The language name. The option page category. The type of the option page. The caption of the option page. The resource ID of the page.

Creates all the registry keys and entries as specified by the class constructor.

[in] A object used to manage registry keys.

Removes all of the registry keys and entries.

[in] A object used to manage registry keys.

Gets the name of the language.

The name of the language. This is the same string that was passed to the class constructor.

Gets the GUID of the option page.

The GUID of the option page.

This attribute is used to declare a Tools Option category for a language.

Initializes a new instance of for the language and option category.

The resource ID of the category. The name of the language. The name of the category.

Registers the Tools Option page.

A that describes the location of the key and its values in the registry

Unregisters the Tools Option page.

A that describes the location of the key and its values in the registry.

Associates a file extension with a particular language service.

Initializes a new instance of the attribute, using the specified language service GUID.

[in] A string containing the GUID of the language service. [in] A string containing the file extension to associate with the language service.

Initializes a new instance of the attribute, using the type of your language service class.

[in] The type of the language service class. [in] A string containing the file extension to associate with the language service.

Puts the file extension and language service GUID into the registry.

[in] A object used to create registry keys and to log progress.

Removes the file extension and language service GUID from the registry.

[in] A object used to remove registry keys and to log progress.

Returns the associated file extension.

Returns the string containing the file extension that was passed to the constructor of the class.

Returns the language GUID.

Returns a object containing the GUID of the language service that was passed to the class constructor.

Informs Visual Studio that a VSPackage provides a language service. Used with the managed package framework (MPF).

Initializes a new instance of the Shell.ProvideLanguageServiceAttribute class.

[in] This is either a string containing a GUID or a type representing the class that implements the language service. The language service GUID is derived from this string or type. [in] The name of the language. This name is used in the registry for registry key and entry names. [in] The resource ID for the localized version of the language name. This is used to present the language name in dialog boxes and other user interface elements.

Creates all of the registry keys and entries as specified by the class constructor.

[in] A object used to manage registry keys.

Removes all of the registry keys and entries as specified by the class constructor.

[in] A object used to manage registry keys.

Determines if the language service supports automatic outlining.

Returns true if the language service supports automatic outlining; otherwise, returns false.

Determines if the language service supports IntelliSense operations.

Returns true if the language service supports IntelliSense operations; otherwise, returns false.

Determines the amount of time before a parse operation is started to support an IntelliSense operation.

Returns the number of milliseconds delay before a parse is started.

Determines the expression evaluator that is used for evaluating expressions.

Returns a string containing the GUID of an expression evaluator; otherwise, returns a null value.

Determines the default setting for the Insert spaces option in the Options dialog box for a language service.

Returns true if the language service initially uses spaces for formatting; otherwise, returns false to indicate the language service uses tabs.

Determines the initial setting of the Enable single-click URL navigation option in the Options dialog box.

Returns true if the Enable single-click URL navigation should be turned off; otherwise, returns false, the option is initially turned on.

Determines whether the Hide Advanced Members option is enabled in the Options dialog box.

Returns true if the Hide Advanced Members option is enabled; otherwise, returns false.

Determines whether the language supports background parsing.

Returns true if background parsing is allowed; otherwise, returns false.

Determines whether the language service can comment and uncomment source code using a single command.

Returns true if commenting is supported; otherwise, returns false.

Determines if the language service supports automatic formatting of the source code.

Returns true if formatting is supported; otherwise, returns false.

Determines if the Line numbers option can be selected in the Options dialog box.

Returns true if the Line numbers option is enabled for use; otherwise, returns false.

Determines the initial state of the Hide Advanced Members option in the Options dialog box.

Returns true if the Hide Advanced Members is initially selected; otherwise, returns false.

Returns the name of the language.

Returns a string containing the name of the language. This is the same string that was passed to the class constructor.

Returns the resource ID used to obtain the localized version of the language name.

Returns a number representing the resource ID. This is the same value that was passed to the class constructor.

Returns the GUID of the language service.

Returns the GUID of the language service. This is the value that was derived from the object passed to the class constructor.

Determines if the language service supports matching language pairs.

Returns true if matching language pairs is supported; otherwise, returns false.

Determines if a language service supports matching language pairs while typing.

Returns true if language pairs can be matched while typing; otherwise, returns false.

Determines the maximum number of errors message that a language service can report for a parsing operation.

Returns a number indicating the maximum number of errors that can be reported.

Determines if the language service supports the IntelliSense Quick Info.

Returns true if the IntelliSense Quick Info is supported; otherwise, returns false.

Determines if the language service is using the built-in colorable items as supplied by Visual Studio.

Returns true if the language service uses the built-in colorable items; otherwise, returns false, indicating the language service is supplying custom colorable items.

Determines if the Statement completion options are enabled in the Options dialog box.

Returns true if the Statement completion options are enabled; otherwise, returns false.

Determines if the Navigation bar option is enabled in the Options dialog box.

Returns true if the Navigation bar option is to be enabled; otherwise, returns false.

Determines if URLs are displayed in such a way as to show they can be clicked. This option is not used.

Returns true if URLs are to be displayed "hot" or clickable; otherwise, returns false.

Determines if the matching language pair is shown in the status bar.

Returns true if the matching language pair is shown in the status bar; otherwise, returns false.

Determines if the Smart Indenting option is enabled in the Options dialog box.

Returns true if the Smart Indenting option is enabled; otherwise, returns false.

Determines if the Window -> New Window command is disabled for a language service.

Returns true if the Window -> New Window command is disabled; otherwise, returns false.

Determines if the language service supports the clipboard format HTML for copy and paste operations.

Returns true if the HTML clipboard format is supported, otherwise, returns false.

This attribute provides a package load key for your package.

Creates a new .

The minimum edition of Visual Studio on which the VSPackage is loaded. This must be the literal edition value provided by Microsoft when obtaining your Package Load Key (PLK). Name of the product that this VSPackage delivers. Products comprised of multiple VSPackages each need their own PLK. The version of the product that this VSPackage implements. VSIP Partner/creator of the VSPackage. Must exactly match the name you provided to Microsoft when you registered for a PLK. companyName is case-sensitive. Resource ID for VSPackage load key. minimumEdition, productVersion, productName or companyName are null.

Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

Returns the registry key name for this package's load key information.

The Registry Key name for the load key information of the VSPackage. A registration context provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered.

Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

Returns a string containing the CompanyName.

The name of your company.

The MinimumEdition property returns a string containing the minimum edition of Visual Studio needed to load your VSPackage.

The minimum edition of Visual Studio needed to load your VSPackage.

The ProductName property returns a string containing the name of your VSPackage.

The name of your VSPackage.

The ProductVersion attribute returns a string containing the version number of your VSPackage.

The version number of your VSPackage.

Gets resource ID for the Package Load Key.

The resource ID for the Package Load Key.

Provides registration information about menu resources used in a VSPackage. This class cannot be inherited.

This constructor creates a new ProvideMenuResourceAttribute object with the given resource ID and version number.

The version number of the menu resource. The ID of the menu resource. It must match the resource ID used in both the satellite (resource-only) DLL and the Command Table Configuration (.ctc) File.

Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

Removes registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

A registration context provided by an external registration tool. The context can be used to remove registry keys, log registration activity, and obtain information about the component being registered.

The ResourceID property returns the value of the resource ID set in the constructor.

The resource ID of the menu resource.

Returns the version number of the menu resource.

The version number of the menu resource.

Informs Visual Studio that the VSPackage provides an object that can be created from the interface. This class cannot be inherited.

This constructor creates a new object with the given object type.

The type of object that the VSPackage can create. This type can have any scoping (public, internal, etc.) but must have a public constructor that takes no arguments.

Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

Removes registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

The ObjectType property returns the object type set in the constructor.

Returns the object type set in the constructor.

Gets or sets the registration method.

The base class for all the attributes that are used to register an option page.

Initializes a new instance of for the specified page.

The name resource ID of the page. The type of the page.

Gets the name resource ID of the page.

The name resource ID of the page.

Gets the type of the page.

The type of the page.

Apply this attribute to independent objects to allow users to configure VSPackages through a custom Tools Options page.

Initializes a new instance of indicating that a particular class implements user configuration support for the VSPackage based on a Tools Options page.

If true, the Tools Options page can be accessed through the Visual Studio automation mechanism. The of the class implementing the Tools Options page. The localized resource ID of the Tools Options page subcategory. The localized resource ID of the Tools Options page category. The canonical nonlocalized name of the Tools Options page subcategory. The canonical nonlocalized name of the Tools Options page category.

Registers the Tools Options page.

A describing the location in the registry and values to be registered.

Removes the Tools Options page key from the registry.

A describing the location in the registry and values to be removed.

Gets the canonical nonlocalized name of the Tools Options page's category.

The canonical nonlocalized name of the Tools Options page category.

Gets the category resource ID for a Tools Options page.

The category resource ID for the Tools Options page.

Gets or sets whether aggregated Tools Options pages are shown.

true if the Tools Options page is to be displayed in the default (complex) view of Tools Options pages.

Gets the canonical nonlocalized name of the Tools Options page.

The canonical nonlocalized name of the Tools Options page.

Gets whether a Tools Options page implementation supports automation.

true if a Tools Options page supports the Visual Studio automation model and can be accessed through the mechanism.

Gets or sets whether a Tools Options page implementation uses the Visual Studio settings mechanism to persist its state.

true if the Tools Options page implementation supports the use of Visual Studio settings to persist its state.

Gets the current instance of .

The current instance of .

Apply this attribute to independent objects used to implement a VSPackage's Visual Studio settings support.

Initializes a new instance of ProvideProfileAttribute.

The localized resource ID of the name used to identify the object implementing a Visual Studio settings category. The of the class implementing Visual Studio settings support. This argument is not implemented. The localized resource ID of a Visual Studio settings category's name. The canonical, nonlocalized name of a Visual Studio settings category. The canonical, nonlocalized name used to identify the object implementing a Visual Studio settings category.

Registers this attribute.

A describing the location of the key and its values in the registry.

Removes the key from the registry.

A describing the location of the key and its values in the registry.

Gets or sets the name of a different category in the profile.

The name of a different category in the profile.

Gets the canonical nonlocalized name of the Visual Studio settings category.

The canonical nonlocalized name of the Visual Studio settings category.

Gets the name resource ID for a Visual Studio settings category.

The localized name resource ID of the Visual Studio settings category.

Gets the localized resource ID of the description of this page of the profile.

The localized resource ID of the description of this page of the profile.

Gets the nonlocalized name of this group.

The nonlocalized name of this group.

Gets or sets the localized resource ID of the group to which this page belongs.

The localized resource ID of the group to which this page belongs.

Gets whether this is also a Tools Options page.

true if this is also a Tools Options page, otherwise false.

Gets the canonical nonlocalized name of this page in the profile.

The canonical, nonlocalized name of the page.

Gets the localized resource ID of the name of this page in the profile.

The localized resource ID of the name of this page in the profile.

Gets the type of the page.

A of the page.

Gets or sets the GUID of a package providing the resource strings.

The GUID of a package providing the resource strings.

ProvideProjectFactoryAttribute declares that a package provides a project factory.

Initializes a new instance of .

The type of factory the VSPackage offers. The default project extension. The possible project extensions supported by this project factory. The name of the project. The directory containing this project factory’s templates. The resource ID of the project file extensions.

Registers this attribute.

. Contains the location where the registration information should be placed, the type being registered, and path information.

Removes the key for this attribute from the registry.

. Contains the location where the registration information should be placed, the type being registered, and path information.

Gets the default extension of the project file.

The default project extension.

Gets the resource ID for project file extensions.

The resource ID for project file extensions.

Gets or sets the Visual Studio template for the project.

The Visual Studio template for the project.

Gets the type of the project factory.

The type of the project factory.

Gets or sets the GUID of the folder for this type of project.

The GUID of the folder for this type of project.

Gets and sets the Visual Studio language template.

The Visual Studio language template.

Gets the name of the type of project.

The project node name.

Gets or sets whether this type of project requires a Visual Studio template that creates a new folder.

true if this type of project requires a Visual Studio template that creates a new folder, otherwise false.

Gets the set of possible project extensions.

The set of possible project extensions.

Gets or sets the Visual Studio template for the project subtype.

The Visual Studio template for the project subtype.

Gets the project templates directory.

The path to the directory where the project templates are located.

Gets or sets the Visual Studio template to be shown in the New Project dialog.

The Visual Studio template.

Gets or sets the order in which projects are displayed in the New Project dialog.

The sort priority for the New Project dialog.

Gets or sets the Visual Studio template's group ID.

The template's group ID.

Gets or sets the Visual Studio template ID.

The template ID.

This attribute registers items to be included in the Add New Item dialog for the specified project type. It is placed on a VSPackage.

Initializes a new instance of for the item.

The display name of the type of item. The directory in which the templates for this project type can be found. The priority of this type (for sorting purposes). The type of project factory. This can be a , a GUID, or the string form of the GUID.

Registers this item type.

A that describes the location and values of the registry key.

Removes the registry key for this item type.

A that describes the location and values of the registry key.

Gets the name of this type of item.

The name of this type of item.

Gets the sort priority of this type.

The sort priority of this type.

Gets the GUID of the type of project factory.

The GUID of the type of project factory.

Gets the directory in which the templates for this project type are found.

The directory in which the templates for this project type are found.

This attribute indicates that the package proffers a service when applied to a subclass of or a class that implements .

Initializes a new instance of .

The type of the service.

Registers this service.

A that describes the location and values of the registry key.

Removes the registry key for this service.

A that describes the location and values of the registry key.

Gets the type of the service.

The type of the service.

Gets or sets the name of the service.

The name of the service.

Gets the GUID of the service type.

The GUID of the service type.

Apply this attribute to classes implementing VSPackages to declare that the VSPackage provides Toolbox items with the specified clipboard format and to enable drag-and-drop support in the Visual Studio Toolbox.

Initializes a new instance of for the specified format.

The name of a supported format. Thrown if the format argument is null.

Gets the name of a supported clipboard format.

The name of the clipboard format.

Registers a VSPackage as supplying a particular implementation of . Used in conjunction with .

Initializes a new instance of .

[in] .

Registers the toolbox item configuration.

A describing the location and values of the registry key.

Removes the registry key.

A describing the location and values of the registry key.

Gets the type of the toolbox item configuration.

The type of the toolbox item configuration.

Apply this attribute to classes implementing VSPackages to declare if they offer a set of items to the Visual Studio Toolbox.

Creates a new instance of which indicates if a class implementing a VSPackage is providing Toolbox items.

The version of the Toolbox items a VSPackage supplies.

Initializes a new instance of for the specified version.

The version of the items. If true, then set the registry key that forces a event after each toolbox reset.

Registers a VSPackage as a Toolbox item provider for specified formats when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

A registration context provided by an external registration tool. The context is used to create registry keys, log registration activity, and obtain information about the component being registered.

Reverses the changes that the method had applied to the registry.

A registration context provided by an external registration tool. The context is used to create registry keys, log registration activity, and obtain information about the component being registered.

Gets or sets whether the event should be raised after each toolbox reset.

true if the event should be raised after each toolbox reset, otherwise false.

Property returning the version of Toolbox items a VSPackage provides.

An integer value containing the version number of the Toolbox items a VSPackage supports.

Registers a VSPackage as providing one or more dialog pages in the Customize Toolbox dialog page of the Visual Studio IDE.

Initializes a new instance of , using the type of the class implementing the Customize Toolbox dialog page, and a resource ID.

[in] The of the class implementing the Customize Toolbox dialog page. This type must derive from the class. [in] The native resource ID in a VSPackage's satellite dll containing the name for the tab hosting this Customize Toolbox dialog page.

Initializes a new instance of , using the type of the class implementing the Customize Toolbox dialog page, a resource ID, and a page order.

[in] The Customize Toolbox dialog page placement in the pages of the Visual Studio Customize Toolbox Dialog. A value of 0 indicates that no order is requested. [in] The type of the class implementing the Customize Toolbox dialog page. This type must derive from the class. [in] The native resource ID in a VSPackage's satellite dll containing the name for the tab of hosting this Customize Toolbox dialog page.

Initializes a new instance of , using the of the class implementing the Customize Toolbox dialog page, a resource ID, a page order, and a help string.

[in] The Customize Toolbox dialog page placement in the pages of the Visual Studio Customize Toolbox Dialog box. A value of zero indicates that no order is requested. [in] The type of the class implementing the Customize Toolbox dialog page. This type must derive from the class. [in] A help keyword used by the help system to find the correct help topic information. [in] The native resource ID in a VSPackage's satellite dll containing the name for the tab of hosting this Customize Toolbox dialog page.

Registers the toolbox page.

A describing the location and values of the registry key.

Removes the toolbox page registry key.

A describing the location and values of the registry key.

Gets a help keyword associated with the Customize Toolbox dialog page.

The help keyword used to obtain information about the Customize Toolbox dialog page.

Gets the page order requested for the Customize Toolbox dialog page

The page order requested for the Customize Toolbox dialog page.

Gets the instance of the class implementing the Customize Toolbox dialog page.

The current instance of the class implementing the Customize Toolbox dialog page.

Notifies Visual Studio that a VSPackage owns a tool window.

Initializes a new instance of .

The type of the tool window.

Registers the tool window.

A describing the location and values of the registry key.

Removes the registry key for the tool window.

A describing the location and values of the registry key.

Gets or sets the default height of the tool window.

The height of the tool window.

Determines whether multiple instances of the tool window are allowed.

true if multiple instances are allowed, otherwise false.

Gets or sets the default orientation for the tool window relative to the window specified by the Window property.

Gets or sets the default horizontal value of the top left corner of the tool window.

The horizontal value of the top left corner of the tool window.

Gets or sets the vertical value of the top left corner of the tool window.

The vertical value of the top left corner of the tool window.

Gets or sets the default docking style for the tool window.

Gets or sets the type of the tool window.

The type of the tool window.

Gets or sets whether the tool window should not be reopened when the IDE restarts.

false if the tool window should be displayed when the IDE restarts if it was displayed when the IDE closed, otherwise true.

Gets or sets the default width of the tool window.

The default width of the tool window.

Gets or sets the GUID of the default window on which the tool window should be docked.

The GUID of the default window on which the tool window should be docked.

Maps a tool window to one or more UI contexts, so that the window is displayed when the user switches to one of those contexts and is hidden when the user switches away from one of the contexts.

Initializes a new instance of for the specified type of the tool window and a GUID to associate with its visibility.

The types of the tool window. This can be the type, the GUID, or the string value of the GUID. The GUID of the tool window to which the automatic visibility behavior should be applied.

Registers the tool window visibility.

A that describes the location and values of the registry key.

Removes the registry key.

A that describes the location and values of the registry key.

Gets the GUID of a command associated with showing or hiding the tool window.

The GUID of a command associated with showing or hiding the tool window.

Gets or sets the name of the window.

The name of the tool window.

This attribute declares that an editor factory class offers a particular logical view.

Creates a new attribute.

An enumeration of the kinds of logical views available. The GUID of the physical view. This can be null to indicate the default physical view.

Gets the logical view in this attribute.

Returns the physical view that is mapped to the logical view.

Registers the VSPackage as an extender that is automatically loaded in response to a particular context GUID. This class cannot be inherited.

Creates a new RegisterAutoLoadAttribute object and saves the GUID of the package that initiated package loading.

Context GUID that triggers the loading of the VSPackage

Provides registration information about a VSPackage when called by an external registration tool such as RegPkg.exe.

Removes registration information about a VSPackage when called by an external registration tool such as RegPkg.exe.

Returns the context GUID that triggers package load.

The context GUID that triggers package load.

See . Registers a file extension with a given editor factory. This class cannot be inherited.

Initializes a new for the supplied factory type and extension.

One of following types:The type of the editor factory expressed as a string.The GUID of the editor factory.The type of the editor factory. The priority of this editor factory. Editors with higher priority numbers are given a chance to read a file first. Upon failure, the next editor in priority order is used. The file extension to associate with the editor factory. This extension should include the prefix “.”. This method throws an if:The factory GUID string cannot be converted to a GUID object. Extension does not begin with a “.”. This method throws an if:Factory GUID value passed in factoryType is null.extension is null.

Registers the editor extension.

A that describes the location and values of a registry key. This method throws an if context is null.

Removes the editor extension registry key.

A that describes the location and values of a registry key. This method throws an if the context argument is null.

Gets or sets whether or not to create the EditorFactoryNotify registry key on registration.

true if the EditorFactoryNotify registry key should be created, otherwise false.

Gets the file extension of the file.

The file extension for this editor.

Gets the editor factory GUID.

The GUID of the editor factory.

Gets or sets the name resource ID.

The name resource ID.

Gets the priority of this extension registration.

The priority for this editor for its file extension.

Gets or sets the project GUID.

The project GUID.

Gets or sets the template directory.

The template directory.

Adds a logical view to the editor created by an editor factory. This attribute has been deprecated. Please use instead.

Initializes a new instance of .

The type of factory. This may be a Type, a GUID or a string representation of a GUID The GUID of the logical view to register.

Registers logical view.

A that describes the location and values of the registry key.

Removes the editor logical view registry key.

A that describes the location and values of the registry key.

Gets the GUID of the factory type.

The GUID of the factory type.

Gets the GUID of the logical view.

The GUID of the logical view.

Registers an extender with Visual Studio. This class cannot be inherited. This class is obsolete. Please use ProvideExtenderAttribute instead.

This constructor creates a new object.

The CATID of the extendee. The GUID of the extender. The name of the extender.

Provides registration information about a VSPackage when called by an external registration tool such as RegPkg.exe.

Removes registration information about a VSPackage when called by an external registration tool such as RegPkg.exe.

Gets the CATID of the object to be extended.

The CATID of the object to be extended.

Gets the GUID of the extender.

The GUID of the extender.

Gets the name of the extender.

The name of the extender.

Registers a file extension with a given language service by applying the attribute to a -derived class or class that implements when registered using a registration tool like regpkg.exe. For more information, see How to: Register Managed VSPackages.

Initializes a new instance of RegisterLanguageExtensionAttribute.

The GUID of language service class that is derived from as a string. The file extension associated with the language service. Include a "." in the value of extension.

Initializes a new instance of RegisterLanguageExtensionAttribute and initializes the values of the language service and file extension that it associates.

The GUID of language service class that is derived from as a string. The file extension associated with the language service. Include a "." in the value of extension.

Registers this attribute with the given context.

Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

Gets the associated file extension.

The associated file extension.

Gets the GUID of the language service.

The GUID of the language service.

Registers a Package load key with the VSPackage. This class cannot be inherited.

Creates a new .

The minimum edition of Visual Studio .NET needed to load the VSPackage. The name of the VSPackage. The version number of the VSPackage. The name of your company. The resource ID for the VSPackage load key. minimumEdition, productVersion, productName or companyName are null.

Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

Retrieves the registry key name for the load key information of the VSPackage.

Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

The CompanyName property returns a string containing the name of your company.

The name of your company.

The MinimumEdition property returns a string containing the minimum edition of Visual Studio needed to load your VSPackage.

The minimum edition of Visual Studio needed to load your VSPackage.

The ProductName property returns a string containing the name of your VSPackage.

The name of your VSPackage.

The ProductVersion attribute returns a string containing the version number of your VSPackage.

The version number of your VSPackage.

Gets resource ID for the Package Load Key.

The resource ID for the Package Load Key.

has been deprecated. Please use instead

Initializes a new instance of .

The name of the item category. The template directory for this project type. The priority of the project type. The type of the project factory.

Registers this item type.

A that describes the location and values of the registry key.

Removes the registry key for this item type.

A that describes the location and values of the registry key.

Gets the name of this type of item.

The name of this type of item.

Gets the sort priority of this type.

The sort priority of this type.

Gets the GUID of the type of project factory.

The GUID of the type of project factory.

Gets the directory in which the templates for this project type are found.

The directory in which the templates for this project type are found.

An abstract class for VSPackage registration. The RegistrationAttribute class allows new registration information to be added without changing the registration tools.

Initializes a new instance of the class.

Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages.

Removes registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see How to: Register Managed VSPackages. Any class deriving from the RegistrationAttribute class must implement this method.

Gets the current instance of this attribute.

The current instance of this attribute.

Provides an abstract class that represents a registration key.

Creates a new object.

Closes a key after writing is complete.

Creates a new registration key. The new key is a subkey of the current Key.

The newly created Key. The name of the new key. This name is relative to the current key.

Adds a value to the current registration Key.

The name of the value to set. If valueName is null or an empty string, SetValue sets the default value for the current Key. An object to store in the value. The object cannot be null. If the object is a numeric type that can be converted to an integer, it is stored as a DWORD registry encoding. Otherwise it is stored as a string.

Disposes the object and its resources.

An abstract base class for objects providing context information from an external source to a registration attribute.

Creates a new RegistrationAttribute.RegistrationContext object.

Creates a new registration key by name.

A new object. The name of the key to create.

Reformats a string as needed by the registration tool.

The reformatted path string. The path string to reformat.

Removes an existing registration key.

The name of the key to remove.

Removes the key of the specified name if it has no child key and no value.

The name of the key to remove.

Removes a value from a registration key.

The name of the value to remove. The name of the key that contains the value to be removed.

Gets the path and filename of the object being registered.

The path and filename of the object being registered.

Gets the path to the component that is being registered.

The path to the component being registered.

Gets the type of component being registered.

The type of component being registered.

Gets the path to the in-process server DLL.

The path to the in-process server DLL.

Gets a object that can be used to log events during registration.

A object.

Gets a value that specifies how the assembly should be registered/located.

Specifies how the assembly should be registered/located.

Indicates that the assembly should be in the GAC or in PrivateAssemblies.

Indicates that the path to the assembly should be stored in the registry and used to locate the assembly at runtime.

Indicates that the registration method should only be used by tools.

Represents information about a document in the . It includes all the information returned by .

The document object in the Running Document Table (RDT).

The number of edit locks held on the document.

The set on the document.

The interface of the hierarchy node that owns the document.

The item ID of the node that holds the document.

The absolute path of the document.

The number of read locks held on the document.

Provides access to the Running Document Table (RDT) that tracks all currently opened documents in Visual Studio.

Initializes a new instance of the class.

[in] An object used to access services. This cannot be a null value.

Enables the client to receive events about changes to the Running Document Table (RDT).

A cookie associated with the given object. If an error occurs, this method throws an exception. [in] An object representing an entity to be called for various running document table events.

Gets an object from the Running Document Table (RDT) that represents the document specified by the given path.

An object that can be cast to an appropriate interface to access the document (see Remarks for details), or null if the document is not registered with Visual Studio. [in] Path to the desired document.

Gets a cookie from the Running Document Table (RDT) that represents the document specified by the given path.

Gets an object, cookie, and owning project type from the Running Document Table (RDT) for the document specified by the given path.

An object that can be cast to an appropriate interface to access the document (see Remarks for details). If a null value is returned, the document is not registered with Visual Studio. [out] Returns the ID of the document in the object. [out] Returns an object that represents the project that owns the requested document. [in] Path to the desired document. [out] Returns the unique value that represents the requested document in the RDT.

Gets information about a document registered in the Running Document Table, given the identifier of the document.

The for the specified document. The identifier of the document data object in the Running Document Table.

Gets an enumerator of the documents in the Running Document Table.

An of type .

Gets the project that owns the specified document.

, otherwise null. [in] Path to the desired document.

Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.

The contents of the document in a string format, or null if the document is not registered with the RDT. [in] Path to the desired document.

Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.

The contents of the document in a string format, or null if the document is not registered with the RDT. [in] The unique value that represents the requested document in the RDT.

Gets a read or edit lock on the specified document.

The identifier of the document to lock. Lock values from the enumeration.

Creates an entry in the running document table when a document is created or opened.

If the method succeeds, it returns . If it fails, it returns an error code. The item ID of the node. The interface of the hierarchy element that owns the document. The absolute path of the document. Lock values from the enumeration. [out] Returns a pointer to the IUnknown interface of the document data object.

Renames a document and optionally gives ownership of the document to the specified project.

[in] An object representing the project that is to take ownership of the document. Pass the value (IVsHierarchy)-1 to indicate no change in ownership is to take place [in] The full path representing the new name. [in] This value can be , , or . Pass to indicate no change in ownership is to take place. [in] The full path representing the original name.

Saves the specified file if it has changed since the last save.

The path to which the file was saved. This is either the original path or a new path specified by the user. [in] The full path to the document to be saved.

Enumerates the documents in the Running Document Table.

An of type .

Indicates the client is no longer interested in receiving Running Document Table (RDT) events.

[in] A unique value returned from the method. See Remarks.

Releases a read or edit lock on the open document.

The identifier of the document data in the Running Document Table. Lock values from the enumeration.

Provides a unified interface for accessing a set of selected objects.

Initializes a new object. The overload provides the ability to restrict user control over the and collections.

Creates a new object with the ability to restrict user control over the and collections.

If true, a request to change the throws a . If false, a request to change the is handled normally. If false, a request to change the throws a . If false, a request to change the is handled normally.

Raised when an external object calls the method with the F:Microsoft.VisualStudio.Shell.SelectionContainer.SELECTED flag set.

Refers to all .

Overriding this method enables an object to respond when selected.

Determines the number of objects either those F:Microsoft.VisualStudio.Shell.SelectionContainer.SELECTED or F:Microsoft.VisualStudio.Shell.SelectionContainer.ALL items.

Returns if the operation is successful. Use F:Microsoft.VisualStudio.Shell.SelectionContainer.ALL to indicate all members and F:Microsoft.VisualStudio.Shell.SelectionContainer.SELECTED to indicate only those selected. A pointer to the number of items, this value is set by the method call.

Sets cObjects with the number of items or items and populates array apUnkObjects with pointers to those objects.

Returns if the operation is successful. A pointer to the number of items, this value is set by the method call. Use to indicate all members and to indicate only those selected. An array of size cObjects that contains pointers to the retrieved objects.

Sets the collection of selectable objects.

Returns if the operation is successful. The array of objects to be selected. The size of the array of selected objects. If this value is true will be performed on the array of objects.

Gets the collection of selectable objects.

Returns a collection of selectable objects.

Gets or sets the collection of selected objects.

Returns a collection of selected objects.

Provides a unified service provider for managed VSPackages.

Initializes a instance with an existing interface.

A interface.

Initializes a new instance of the class with an existing object and optionally passes all requests to the underlying service provider.

Determines if this service should respond to queries for and . An interface used to resolve services.

Releases the resources used by the object.

Gets the specified service from the unmanaged service provider.

The requested service, or null if the service could not be located. The GUID of the service to retrieve.

Gets type-based services from the unmanaged service provider.

The requested service, or null if the service could not be located. The type of service to retrieve. The GUID of this type is used to obtain the service from the native service provider.

Gets the current site object to resolve services.

The retrieved interface or null. The GUID of the requested interface.

Sets the site object to resolve services.

The site to be set.

A hierarchical service provider that stores objects in a sorted collection for an ordered retrieval. When is called to retrieve a service, the service providers are queried in a specific order. This is useful when multiple service providers are combined, such as in the implementation.

Initializes a new instance of .

Gets a service of the specified type.

The requested service, or null if the service cannot be found. This service must be cast to the required service type. The type of the service.

Provides a recommended service resolution order for common service providers. When multiple service providers are combined in a service provider hierarchy, they are given a numeric ordering.

Initializes a new instance of .

The order for a package service provider.

The order for a project item context service provider.

The order for a window pane service provider.

An implementation of , used to modify the appearance and functionality of a task in the task list.

Initializes a new instance of .

Initializes a new instance of for the supplied exception.

The used to create the task.

Handles events.

Represents the keyword for the user context. This field is constant.

Creates a new user context.

If the method succeeds, it returns . If it fails, it returns an error code. [out] The that has been created.

Gets whether or not it is possible to delete the task.

. [out] Returns true if it is possible to delete the task, otherwise false.

Sets the task category.

If the method succeeds, it returns . If it fails, it returns an error code. An array of objects.

Gets the column number of the file associated with the task.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns the column number.

Gets the name of the file associated with the task.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns the name of the file.

Determines whether the task item's check box is currently selected or cleared.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns true if the check box is selected, otherwise false.

Gets the priority of the task.

If the method succeeds, it returns . If it fails, it returns an error code. An array of objects.

Gets the description of the task.

If the method succeeds, it returns . If it fails, it returns an error code. [out] The description of the task.

Determines whether or not the task has associated help.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns true if there is help associated with the task, otherwise false.

Gets the index of the image associated with the task.

If the method succeeds, it returns . If it fails, it returns an error code. [out] The index of the associated image.

Determines whether or not the specified task field is read-only.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns true if the field is read-only, otherwise false. The .

Gets the line number of the file associated with the task.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns the line number of the file.

Opens a file associated with a task and moves to the appropriate position in the file.

Opens the Help resource associated with a task.

Raised when a task has been deleted.

Raised when a task has been filtered into or out of a view.

. If true, the task has become visible, otherwise it has become invisible.

Sets whether a task item's check box is selected or cleared.

. true if the check box is selected, false if it is cleared.

Sets the priority level of a task item.

. The .

Sets the description of the task.

. The description of the task.

Gets the index of the task in the subcategory list.

. [out] Returns the index.

Raised when the task has been deleted.

Raised when the user requests Help; for example by right-clicking and selecting Show Error Help.

Raised when the user attempts to navigate to the task's location in the file, for example by double-clicking on the task.

Raised when a task has been removed from the task list.

Gets or sets whether or not the task can be deleted.

true if the task can be deleted, otherwise false.

Gets or sets the task's category.

Gets or sets whether not the task's check box is currently selected or cleared.

true if the task is checked, otherwise false.

Gets or sets the column number within the file associated with the task.

The column number of the task.

Gets or sets the file associated with the task.

The name of the file.

Gets or sets the Help keyword associated with the task.

The Help keyword.

Gets or sets the index of the image associated with the task.

The index of the image associated with the task.

Gets or sets whether or not it is possible to edit the checked state of the task.

true if it is possible to edit the checked state of the task, otherwise false.

Gets or sets whether or not it is possible to edit the priority of a task.

true if it is possible to edit the priority of a task, otherwise false.

Gets or sets whether or not it is possible to edit the description of a task.

true if it is possible to edit the description of a task, otherwise false.

Gets or sets the line number of the file associated with the task.

The line number of the file associated with the task.

Gets or sets the priority of a task.

Gets or sets the index of the subcategory of the task.

The index of the subcategory of a task.

Gets or sets the description of a task.

The description of a task.

Provides a set of task categories that specify the kind of task that is to be performed.

All tasks. Not a real category. It is used to allow a task list view to show all of the tasks in the task list.

Build errors and warnings, and possibly deployment errors.

Errors generated as the user types source code.

Tasks generated by special comments, such as "TODO," "UNDONE," or "TBD." Also used for informational messages.

Tasks which pertain to Web page development. .

Miscellaneous tasks.

Short cuts to code. Shortcuts are generated by the user right-clicking the editor window, and choosing Add Task List Shortcut from the pop-up menu.

User-defined tasks.

Represents a collection of values that identify types or severity of error messages that can appear in the Error List Options task window.

Represents an error.

Represents an informational note.

Represents a warning.

Provides values for task priorities.

High priority.

Low priority.

Normal priority.

This class implements . It provides a framework-friendly way to define a task provider and its associated services.

Initializes a new instance of the with the supplied service provider.

Disposes this provider.

Disposes the resources (task collection, task list, and image list) of this provider.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Destroys the provider.

Gets the service of the specified type.

An object representing the service. The type of the service.

Gets an enumerator over the task items.

If the method succeeds, it returns . If it fails, it returns an error code. [out] .

Gets this provider's image list.

If the method succeeds, it returns . If it fails, it returns an error code. [out] .

Notifies the client to unregister the task provider from the task list if it has not been unregistered by the time the task list is closing.

. The task list.

Gets the re-registration key.

. [out] Returns the key.

Gets a list of subcategories for the tasks of this task provider.

. An array of subcategories The number of subcategories in rgbstr. [out] The number of subcategories.

Gets an enumerator over task items.

If the method succeeds, it returns . If it fails, it returns an error code. [out] .

Gets this provider's image list.

If the method succeeds, it returns . If it fails, it returns an error code. [out] .

Gets or sets whether or not the task list should maintain the task order given to it by the task provider.

. [out] Returns true if the task order should be maintained, otherwise false.

Notifies the client to unregister the task provider from the task list if it has not been unregistered by the time the task list is closing.

If the method succeeds, it returns . If it fails, it returns an error code. The task list.

Gets the reregistration key.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns the key.

Gets a list of subcategories for the tasks of this task provider.

If the method succeeds, it returns . If it fails, it returns an error code. An array of subcategories The number of subcategories in rgbstr. [out] The number of subcategories.

Gets the definition of the column with the specified index.

When implemented by derived classes, or an error code. The index of the column. An array of structures.

Gets the total number of columns supported by this provider, including columns that are not visible by default.

When implemented by derived classes, or an error code. [out] Returns the total number of columns. By default returns 0.

Gets the behavior flags for this provider.

. [out] Returns .

Gets a unique GUID for this provider. This is used to persist and restore provider-specific data managed by the task list, such as user customizations of column width and order.

. [out] The GUID of the provider's type.

Gets the name of the provider.

. [out] The name of the provider.

Gets the provider's toolbar.

. [out] The GUID of the group to which the toolbar belongs. [out] The ID of the toolbar.

If this method is implemented, all the provider's tasks will be listed under the surrogate provider in the list as though they belonged to the surrogate provider.

When implemented by derived classes, or an error code. [out] The GUID of the surrogate provider. By default returns an empty GUID.

Raised when the user begins editing a task in place.

. The being edited.

Raised when the user finishes editing a task in-place.

. [out] Returns true if the changes have been committed, false to disallow the user from leaving edit mode. true if the user wishes to commit the changes, false if the user wishes to discard them. The being edited.

Navigates from the task to the correct position in the document, shown in the specified logical view.

true if it was possible to perform the navigation, otherwise false. The task from which to do the navigation. The logical view in which to display the document.

Informs the task list that there are new or edited tasks.

Restarts the refreshing of the task list after it has been suspended.

Displays the task list window.

Stops refreshing the task list until is called.

Determines whether or not the provider is always visible in the dropdown menu even though it has no tasks.

true if it is always visible, otherwise false.

Gets or sets whether autorouting should be disabled.

true if autorouting should be disabled, false if it should be enabled.

Gets or sets the provider's image list (a list of icons for the tasks that belong to the provider).

Gets or sets whether or not the task list should maintain the task order given to it by the task provider.

true if the task order should be maintained, otherwise false.

Gets or sets the GUID of this provider.

The GUID of this provider.

Gets or sets a localized name for this provider.

The localized name of the provider.

Gets a collection of task subcategories.

A of task subcategories.

Gets a collection of tasks.

Gets or sets a group GUID and toolbar ID indicating which toolbar should be displayed when this provider is active.

The group GUID and toolbar ID indicating which toolbar should be displayed when this provider is active.

Gets or sets this provider's toolbar ID.

The toolbar ID.

Gets the task list.

A container for objects.

Initializes a new instance of for the supplied task provider.

The task provider that owns these tasks.

Adds a task to the collection.

The index of the added task. The task to add.

Removes all the tasks from the collection.

Gets whether or not the task exists in the collection

true if the task exists in the collection, otherwise false. The task for which to search.

Gets an enumerator for the collection.

Gets the index of the specified task in the collection.

The index of the task. The task for which to search.

Inserts a task in the collection at the specified index.

The task to insert. The index at which to insert the task.

Removes a task from the collection.

The task to remove.

Removes the task at the specified index.

The index at which to remove the task.

Copies the collection to an array, starting at the specified index.

The array to which to copy the collection. The index of the array at which to start the copy.

Adds the task to the collection.

The index at which the task was added. The task object.

Removes all the tasks from the list.

Gets whether or not the specified task exists in the collection.

true if the task exists in the collection, otherwise false. The task to find.

Gets the index of the collection at which the specified task exists.

The index of the collection at which the task exists. The task to find.

Inserts a task in the collection at the specified index.

The task to insert. The index at which to insert the task.

Removes the specified task from the collection.

The task to be removed.

Removes the task from the specified index of the collection.

The index at which to remove the task.

Gets the number of tasks in the collection.

The number of tasks in the collection.

Gets or sets the task at the given index.

. The index of the task.

Gets whether or not the collection is synchronized.

By default returns false.

Gets the object that can be used to synchronize access to the collection.

By default returns the current instance of this collection.

Gets whether or not the collection is of a fixed size.

By default returns false.

Gets whether or not the collection is read-only.

By default returns false.

Gets or sets the task at the specified index.

The specified task. The index of the collection.

This enumeration provides a number of possible tool window orientations with respect to a docking window.

Tool window initially oriented against the bottom of the docking window.

Tool window initially oriented to the left of the docking window.

No tool window orientation indicated.

Tool window initially oriented to the right of the docking window.

Tool window initially oriented against the top of the docking window.

A default implementation for a tool window. It can be subclassed for a customized tool window.

Initializes an instance of this class.

The single constructor argument is a service provider the created window can use to obtain services. This parameter must not be null, or else the tool window will not be able to add itself to the shell.

Gets the associated with the tool window.

Called when a toolbar is added to the tool window.

This method can be overridden by the derived class to execute any code that needs to run after the creation of .

Gets or sets the index of the image to use in the bitmap strip for the window frame icon.

The index of the image to use for the window frame icon.

Gets or sets the resource ID for the bitmap strip from which to take the window frame icon.

The resource ID for the bitmap strip.

Gets or sets the caption for the tool window.

The caption of the tool window.

Gets or sets the hosting the ToolWindowPane.

Gets or sets the package owning the tool window.

Gets or sets the .

if the tool window has a toolbar, otherwise null.

Gets or sets the location of the toolbar in the tool window.

A value from the enumeration.

Gets or sets the CLSID of a tool that should be used for this tool window.

The CLSID of the tool.

Wraps the class. It provides an unescaped version of for file URL types and for HTTP URL types. It also returns an unescaped result from so that it can be presented to the user.

Initializes a new instance of for the specified path.

The path for which to create the URL.

Initializes a new instance of based on the specified base and relative path.

The base . The relative path.

Gets the unescaped path up to the specified index.

The unescaped path up to the specified index of the array. The index of the array up to which to get the path.

Gets the unescaped remainder of the path, starting at the specified segment.

The unescaped remainder of the path, starting with the specified index of the array. The index of the array at which to start getting the path.

Joins the specified segments into a path.

The unescaped path starting at segment i and not including segment j or higher. The index of the array at which to stop adding segments to the path. The index of the array at which to start the path.

Makes the specified relative with respect to the current one.

Using the current as the base, the relative path of url. The to make relative.

Moves the URL from the old base to the new one.

The new . The new base. The original base.

Converts an escaped string to an unescaped string.

The unescaped string. The string to convert. true if the string represents a file URL, otherwise false.

Gets the absolute URL as a string.

The string value of the absolute URL.

Returns the unescaped absolute URL for the parent directory containing the file referenced by this URL object.

The unescaped absolute URL of the parent directory.

Determines whether or not the URL represents a file (as opposed to an HTTP location).

true if the URL represents a file, otherwise false.

Gets an array of the URL's segments.

An array of the URL's segments.

Gets the URI for this URL.

Defines constants for tool window orientation.

If the Style value is , the tool window cannot be docked.

If the Style value is , the tool window will float initially, but when the title bar is double-clicked, Orientation and Window apply, and the window will default to Tabbed.

If the Style value is , Orientation can be Left, Right, Top, or Bottom.

If the Style value is , the tool window will be linked to the MDI area, and Window is ignored.

The registration attribute initializes to this value of no style specified.

If the Style value is , Orientation can be Left or Right and specifies where the tab will be placed.

Includes the GUIDs for Visual Studio menu commands.

Provides static helper methods to use when dealing with the Visual Studio shell.

Empties the task list.

If the method succeeds, it returns . If it fails, it returns an error code. .

Gets the current debug mode of the shell, for example design mode, running mode, or break mode.

One of the values. .

Gets the hierarchy node specified by the project GUID.

The interface of the project. . The GUID of the project.

Gets the miscellaneous project from the current solution.

The interface of the miscellaneous project. .

Returns the miscellaneous project in a solution.

The interface of the miscellaneous project. true if the project should be created, otherwise false. object used to retrieve the object.

Gets the output window pane specified by the GUID.

The interface specified by the GUID. . The GUID of the output window pane.

Returns a project for the specified document.

The interface of the project that contains the document. The object used to retrieve the object. The unique identifier of the document in the project system.

Gets an interface and a document cookie from the running document table for the specified document.

[out] The identifier of the document held by the running document table. [out] The item ID of the document. [out] The interface of the project containing the document. . The moniker of the file. [out] The interface for the document.

Gets the text of the specified file, if it exists in the running document table.

The text of the file. . The absolute path of the file.

Gets a list of tasks.

An of type of the task items. .

Gets the text view in the specified window frame.

The text view in an object, or null if the window frame is a code window that is not implemented as a text view. that contains the text view.

Gets a window for the given GUID.

. . The GUID of the hierarchy window.

Gets the window that exists in the specified window frame.

The , if there is an object of that type in the frame, otherwise null. The interface for the window frame.

Determines whether or not the specified document is open.

true if the document is open in the given logical view. If logicalView is Guid.Empty, then this method returns true if any view is open, otherwise false. The GUID of the logical view. [out] Returns the interface of the project that contains the document. [out] Returns the in which the document is open. . The full path to the document. [out] Returns the item ID of the document.

Determines whether or not the extensibility object is currently executing an automation operation.

true if the extensibility object is executing an automation operation, otherwise false. .

Determines whether or not the build manager is busy.

true if the build manager is building or deploying the built application, otherwise false. .

Determines whether or not Visual Studio is in design mode (as opposed to run or debug mode).

true if vsprvs is in design mode, otherwise false. .

Launches the debugger.

A structure. .

Opens the specified miscellaneous file in the specified editor.

The path of the file. The logical view of the editor, for example . The name of the type of window in which to open the editor. The GUID of the editor in which to open the file. The name of the file. .

Opens the specified document.

The path of the document. .

Opens the specified document in the specified view.

The GUID of the logical view in which to open the document. [out] Returns the interface of the project that contains the document. [out] Returns the interface of the window in which the document is open. . The absolute path of the document. [out] The item ID of the document.

Opens the specified document in the specified logical view.

[out] Returns the interface of the primary view of the window. The GUID of the logical view in which to open the document. [out] Returns the interface of the project that contains the document. [out] Returns the interface of the window in which the document is open. . The absolute path of the document. [out] The item ID of the document.

Opens the specified document with the specified editor.

The interface of the window in which the document was opened. The GUID of the logical view in which to open the document. The GUID of the type of editor to use. . The absolute path of the document.

Opens the specified document with the specified editor.

The GUID of the logical view in which to open the document. [out] The interface of the project containing the document. [out] the interface of the window in which the document was opened. The GUID of the type of editor to use. . The absolute path of the document. [out] The item ID of the document.

Displays a message box with the specified title that prompts the user to respond yes/no to the specified message.

true if the operation succeeded, otherwise false. The that defines the type of message. The interface of shell in which to display the message box. The message to which the user must respond. The title of the message box.

Renames the specified document.

The new absolute path of the document. . The current absolute path of the document.

Saves the file in the specified text view if it is dirty.

The interface of the file to be saved.

Saves the specified file if it is dirty.

. The absolute path of the file.

Displays a message box with the specified message.

If the method succeeds, it returns . If it fails, it returns an error code. The value specifying the type of message. The message to display. The value specifying the set of buttons to display. . The value specifying which button is to be the default button. The title of the message box.

A default implementation of a tool window pane. This class implements , but the implementer must provide an implementation of an object that returns an . This class also implements , mapping it to and , mapping the site to services that can be queried through its protected method.

Initializes a new instance of with the specified service provider.

. Should be null. For more information, see Remarks.

Disposes the window pane and its resources.

Disposes the resources of the window pane.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Gets the service of the specified type.

The service. The type of the service to get.

Initializes services after the window pane has been sited.

Executes the specified command.

Returns if the project manager is closed or the command is not supported. Otherwise returns or an error code if one of the executed commands returned an error code. The ID of the command. The GUID of the command group to which the command belongs. Pointer to a VARIANTARG structure containing input arguments. Can be null. Values taken from the enumeration, which describe how the object should execute the command. Pointer to a VARIANTARG structure containing command output. Can be null.

Queries the object for the status of one or more commands generated by user interface events.

If the method succeeds, it returns . If it fails, it returns an error code. The number of commands in the prgCmds array. Unique identifier of the command group. All the commands that are passed in the prgCmds array must belong to the group specified by guidCmdGroup. A caller-allocated array of structures that indicate the commands for which the caller needs status information. This method fills the cmdf member of each structure with values taken from the enumeration. Pointer to an structure to return a name and/or status information of a single command. Can be null to indicate that the caller does not need this information.

Raised when a message is broadcast to the window.

If the method succeeds, it returns . If it fails, it returns an error code. A long integer parameter for the message. The broadcast message. A word value parameter for the message.

Closes the window pane.

If the method succeeds, it returns . If it fails, it returns an error code.

Creates a window pane.

. The absolute y ordinate. A pointer to the parent window. [out] A pointer to the new window pane. The height of the window. The width of the window. The absolute x ordinate.

Gets the default size of the window pane.

When implemented by derived classes, if the method succeeds, it returns . If it fails, it returns an error code. An array of structures.

Loads the saved view state.

When implemented by derived classes, if the method succeeds, it returns . If it fails, it returns an error code. The from which to load the view state.

Saves the loaded view state.

When implemented by derived classes, if the method succeeds, it returns . If it fails, it returns an error code. The to which to save the view state.

Initializes this window pane with the specified service provider.

. .

Handles the translation of navigation keys.

If this method succeeds, it returns ; if it fails, it returns . An array of structures containing the character or character combination to be translated.

Raised when the window is closed.

Raised when the window pane is created.

Preprocesses the messages from navigation keys.

true if it was possible to get a control from the message's handle, otherwise false. The .

Gets the service of the specified type.

An object that represents the service. The type of the service to get.

Gets the window associated with this window pane.

A project that is a subtype or flavor of an inner project. All methods by default delegate to the inner project. Non-default behaviors should be handled by the flavored project.

When overridden in a derived class, initializes an instance of the class.

Raised after a directory has been added to the project.

Raised after a directory has been removed from the project.

Raised after a directory in the project has been renamed.

Raised after a file has been added to the project.

Raised after a file has been removed from the project.

Raised after a file in the project has been renamed.

Raised after the source code control status of an item in the project has changed.

The interface of the inner project.

The of the inner project.

The interface of the inner project.

The service provider of the project.

Subscribes to hierarchy events.

A unique value, or cookie, that is needed to disable notification of hierarchy events. .

Closes and cleans up a hierarchy once the environment determines that it is no longer used.

Executes a command on a specific item within a UI hierarchy window, or on the hierarchy itself.

If the method succeeds, it returns . If it fails, it returns an error code. A pointer to a VARIANTARG structure to receive command output. Can be null. The identifier of the item affected by the command. For single selection, this value is the actual item ID. For multiple selections, set itemid equal to . A pointer to a VARIANTARG structure containing input arguments. Can be null. The command to be executed. This command must belong to the group specified with pguidCmdGroup. Unique identifier of the command group. All the commands in nCmdID must belong to the group specified by pguidCmdGroup. A member of the enumeration, describing the type of action to perform.

Gets the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the hierarchy item. [out] The canonical name of the hierarchy item.

Gets properties whose values are GUIDs.

The GUID value of the property. The item ID of the hierarchy node for which to get the property. The ID of the property.

Determines whether or not a node is a nested hierarchy.

If itemid is not a nested hierarchy node, this method returns . If the requested interface is not supported on the hierarchy object, is returned. The caller would then treat this node as if it had no children. [out] Returns the item ID of the nested hierarchy node; this will always be . The item ID of the node. The interface ID of the node. [out] Returns a pointer to the node, if it is a nested hierarchy node.

Gets the value of a property for a given node.

If the method succeeds, it returns . If it fails, it returns an error code. The item ID of the node. The ID of the requested property. [out] The value of the property.

Gets the service provider from which to access the services.

Called by the outer project subtype to have the owned inner project subtype do its initialization work.

The name of the project file. The name of the project. Flags from the enumeration. [out] Returns true if project creation was canceled. [ref] The interface ID of the project. The path of the project file.

Executes a specified command or displays help for a command.

If the method succeeds, it returns . If it fails, it returns an error code. A pointer to a VARIANTARG structure containing command output. May be null. A pointer to a VARIANTARG structure containing input arguments. May be null. The ID of the command. The ID of the command group to which the command belongs. A member of the enumeration, describing the type of action to take.

Queries the object for the status of one or more commands.

If the method succeeded, , otherwise an error code. Pointer to an structure in which to return name and/or status information of a single command. Can be null. An array of structures that contain information about the commands. The number of commands in the command array. The GUID of the command group to which the commands belong.

Gets the list of project type GUIDs that make up the aggregate project. This method should be delegated to the innermost project within the system of aggregated project subtypes.

If the method succeeds, it returns . If it fails, it returns an error code. [out] A semicolon-delimited set of project type GUIDs.

Called by the outer project subtype to have the inner project subtype do its initialization work.

If the method succeeds, , otherwise an error code. The project file name of the project to be initialized. [out] true if the project was canceled. The name of the project. Flags that describe how a project is to be created or opened. Values are taken from the enumeration. [out] A pointer to the project. [ref] The interface ID of the project. It should be . The path of the project file.

Called to continue initialization after aggregation is complete.

If the method succeeded, , otherwise an error code.

Updates the list of GUIDs that are persisted in the project file of the base project.

If the method succeeds, it returns \. If it fails, it returns an error code. The GUIDs to set.

Sets up the inner project as well as the necessary interface pointers.

If the method succeeds, it returns . If it fails, it returns an error code. The IUnknown of the inner project subtype.

Subscribes to hierarchy events.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns the unique identifier used to unsubscribe for these events. The to which to register.

Closes and cleans up a hierarchy once the environment determines that it is no longer used.

If the method succeeds, it returns . If it fails, it returns an error code.

Gets a unique name for an item in the hierarchy. Used for workspace persistence, such as remembering window positions.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the hierarchy item. [out] The canonical name of the item.

Gets properties whose values are GUIDs.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the hierarchy item. The ID of the property. [out] Returns the GUID value of the property.

Determines whether or not a node is a nested hierarchy.

Gets properties of a given node or of the hierarchy.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the item. The ID of the property. [out] The value of the property.

Gets the service provider from which to access the services.

If the method succeeds, it returns . If it fails, it returns an error code. .

Returns the identifier of the hierarchy item, given its canonical name.

If the method succeeds, it returns . If it fails, it returns an error code. [out] The ID of the item. The canonical name of the item.

Determines whether the hierarchy can be closed.

If the method succeeds, it returns . If it fails, it returns an error code. [out] Returns true if the hierarchy can be closed, otherwise false.

Sets properties whose values are GUIDs.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the item. The ID of the property to set. The GUID value of the property.

Sets properties of a specific node or of the hierarchy.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the item. The ID of the property to set. The value of the property.

Sets the service provider from which to access the services.

If the method succeeds, it returns . If it fails, it returns an error code. .

Disables client notification of hierarchy events.

If the method succeeds, it returns . If it fails, it returns an error code. The unique identifier that was handed back with .

A placeholder for a future method.

Implementers should return .

A placeholder for a future method.

Implementers should return .

A placeholder for a future method.

Implementers should return .

A placeholder for a future method.

Implementers should return .

A placeholder for a future method.

Implementers should return .

Raised after directories have been added to a project.

. The number of directories to be added. The number of projects in the rgpProjects array. An array of paths of the directories that were added. An array of . May be null. An array of objects, corresponding to the projects in the solution. An array of indices of the directories that were affected.

Raised after files have been added to a project.

. The number of projects in the rgpProjects array. The number of files to be added. An array of paths of the files that were affected. An array of . May be null. An array of objects. An array of indices of the files that were affected.

Raised after a directory was removed from the project.

. The number of directories affected. The number of projects in the rgpProjects array. An array of paths of the directories that were affected. An array of . May be null. An array of objects, corresponding to the projects in the solution. An array of indices of the directories that were affected.

Raised after files have been removed from the project.

. The number of projects in the rgpProjects array. The number of files that were affected. An array of paths of the files that were affected. An array of . May be null. An array of objects, corresponding to the projects in the solution. An array of indices of the files that were affected.

Raised after a directory has been moved or renamed.

. An array of the new paths of the directories. The number of projects in the rgpProjects array. The number of directories affected. An array of . May be null. An array of the old paths of the directories. An array of objects, corresponding to the projects in the solution. An array of indices of the directories affected.

Raised after files have been moved or renamed.

. An array of the new paths of the files. The number of projects in the rgpProjects array. The number of files affected. An array of . May be null. An array of the old paths of the files. An array of objects, corresponding to the projects in the solution. An array of the indices of the files.

This method is called by the source code control component to inform listeners that source control status has changed. Do not call this method.

. An array of SccStatus flags. May be null. The number of projects in the rgpProjects array. The number of files affected. An array of paths of the files. An array of objects, corresponding to the projects in the solution. An array of the indices of the files.

Raised by a project to determine whether directories can be added to the project. Not used.

. The number of directories affected. An array of paths to the directories. An array of . An array of . An array of summary objects, which represent a summary of the yes/no values returned. The affected.

Raised to determine whether files can be added to the project. Not used.

. An array of summary objects, which represent a summary of the yes/no values returned. The number of files affected. An array of . An array of . The affected. An array of paths of the files.

Raised to determine whether directories can be removed from the project. Not used.

. The number of directories affected. An array of . An array of . An array of summary objects, which represent a summary of the yes/no values returned. The affected. An array of paths of the directories.

Raised to determine whether files can be removed from the project. Not used.

. An array of summary objects, which represent a summary of the yes/no values returned. The number of files affected. An array of . An array of . The affected. An array of paths to the files.

Raised to determine whether directories can be renamed in the project. Not used.

. An array of the new paths of the files. An array of summary objects, which represent a summary of the yes/no values returned. The number of directories affected. An array of . An array of . An array of the old paths of the files. The affected.

Raised to determine whether files can be renamed in the project. Not used.

. An array of the new paths of the files. An array of summary objects, which represent a summary of the yes/no values returned. The number of files affected. An array of . An array of . An array of the old paths of the files. The affected.

Subscribes to hierarchy events.

The cookie. . A unique value, or cookie, that is needed to disable notification of hierarchy events.

Closes the project and cleans up its resources once the environment determines that it is no longer used.

Executes a command on a specific item within a UI hierarchy window, or on the hierarchy itself.

If the method succeeded, , otherwise an error code. A pointer to a VARIANTARG structure to receive command output. Can be null. The identifier of the item affected by the command. For single selection, this value is the actual item ID. For multiple selections, set itemid equal to . A pointer to a VARIANTARG structure containing input arguments. Can be null. The command to be executed. This command must belong to the group specified with pguidCmdGroup. Unique identifier of the command group. All the commands in nCmdID must belong to the group specified by pguidCmdGroup. A member of the enumeration, describing the type of action to perform.

Gets the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the hierarchy item. [out] The canonical name of the item.

Gets properties whose values are GUIDs.

. The item ID of the hierarchy node for which to get the property. [out] The GUID value. The ID of the property.

Determines whether or not a node is a nested hierarchy.

If itemid is not a nested hierarchy node, this method returns . If the requested interface is not supported on the hierarchy object, is returned. The caller would then treat this node as if it had no children. The item ID of the node. [out] Returns a pointer to the node, if it is a nested hierarchy node. The interface ID of the node. [out] Returns the item ID of the nested hierarchy node; this will always be .

Gets the value of a property for a given node.

If the method succeeds, it returns . If it fails, it returns an error code. The item ID of the node. The ID of the requested property. [out] The value of the property.

Gets the service provider from which to access the services.

. [out] .

Returns the identifier of the hierarchy item, given its canonical name.

If the method succeeds, it returns . If it fails, it returns an error code. [out] The ID of the item. The canonical name of the item.

Determines whether the hierarchy can be closed.

true if the hierarchy can be closed, otherwise false. [out] Returns true if the hierarchy can be closed, otherwise false.

Gets the status of the specified commands.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the item being queried. A pointer to an structure containing name and/or status information on the command. An array of command structures with information on the commands. The number of commands in the prgCmds array. The GUID of the command group to which the commands belong.

Sets properties whose values are GUIDs.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the item. The ID of the property to set. The GUID value of the property.

Sets properties of a specific node or of the hierarchy.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the item. The ID of the property to set. The value of the property.

Sets the service provider from which to access the services.

. .

Disables client notification of hierarchy events.

If the method succeeds, it returns . If it fails, it returns an error code. The unique identifier that was handed back with .

A placeholder for a future method.

Implementers should return .

A placeholder for a future method.

Implementers should return .

A placeholder for a future method.

Implementers should return .

A placeholder for a future method.

Implementers should return .

A placeholder for a future method.

Implementers should return .

Subscribes to events. It is not required to flavor a project but makes it easier for derived classes to subscribe to these events.

Returns the identifier of the hierarchy item, given its canonical name.

If the method succeeds, it returns . If it fails, it returns an error code. [out] The ID of the item. The canonical name of the item.

Determines whether the hierarchy can be closed.

true if the hierarchy can be closed, otherwise false.

Gets the status of the specified commands.

Sets properties whose values are GUIDs.

The ID of the item. The ID of the property to set. The GUID value of the property.

Sets up the interfaces and menu commands for the inner project.

The inner project subtype.

Sets properties of a specific node or of the hierarchy.

If the method succeeds, it returns . If it fails, it returns an error code. The ID of the item. The ID of the property to set. The value of the property.

Gets the service of the specified type.

A service of the type specified. The type of the service.

Disables client notification of hierarchy events.

The unique identifier that was handed back with .

A placeholder for a future method.

Represents the method that handles events relating to files and folders of the flavored project.

A factory for creating flavored projects, otherwise known as project subtypes.

Initializes a new instance of .

Determines whether or not the project can be created with the supplied parameters.

true if the project file name is valid, otherwise false. The name of the file. Not used.

Creates a project.

The name of the project file. [out] Returns true if the operation was canceled, otherwise false. The name of the project. Values from . [out] Returns a pointer to the project. The path of the project file. The interface ID of the project.

Disposes the service provider.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Initializes the project factory.

Gets a semicolon-delimited string of project type GUIDs.

. The name of the project file. [out] Returns the semicolon-delimited string of project type GUIDs.

Creates an aggregatable inner project.

If the method succeeds, it returns . If it fails, it returns an error code. The outer project, or null if the outer project is to be created. [out] Returns the inner project.

Determines whether or not the project can be created.

If the method succeeds, it returns . If it fails, it returns an error code. The name of the file. [out] Returns true if the project can be created, otherwise false. If used, values from the enumeration.

Disposes this object.

Creates a flavored project.

. The name of the project file. [out] Returns true if the operation was canceled, otherwise false. The name of the project. Values from . [out] Returns a pointer to the project. The path of the project file. The interface ID of the project.

Initializes the project and allows the project to obtain services proffered by the environment.

. .

Creates an instance of the project.

If the method succeeds, it returns . If it fails, it returns an error code. The outermost project, or null if the outer project is being created.

Gets the set of project type GUIDs from the project file.

When implemented by a derived class, a semicolon-delimited string containing the project type GUIDs in the project file. The project file.

Gets the project's service provider.

Contains event data for events relating to files and folders of the project subtype, for example the event.

Initializes a new instance of .

Gets or sets the unique name of the project item that was changed.

The unique name of the project item that was changed.