Microsoft.VisualStudio.Shell

Provides methods for dealing with common COM error codes.

Checks if a HRESULT is an error return code.

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

Checks if a HRESULT is a success return code.

Returns true if hr represents a success otherwise returns 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 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 to test. If hr is found in this array of expected failures no exception should be thrown.

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

Adds a named handler to its underlying handler collection.

The name of the handler.

Tests if a named handler is in the underlying handler collection.

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

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.

Provides Win32 window management functions.

Initializes a new instance of the class.

Determines if a message is intended for a modeless dialog box.

The message in question. A handle to the child window.

Changes the parent window of the specified child window.

The new parent window. The child window that should receive a new parent.

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

This constructor creates a new object with the given registry root.

The default registry root used to register VSPackage information.

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

Used to change the control contained by the form to an IVsWindowPane.

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.

Explicitly called to release resources.

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

Return the client area of this form.

The left and top coordinates are both equal to zero. The right is equal to ClientSize.Width and the bottom is equal to ClientSize.Height.

Store the toolbar to the provided size rect and resizes the main pane to leave room for the commandbar.

The new desired bounds. The kind of service requested.

Provided processing for input mouse messages.

A message from the toolbar.

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.

Creates a new dialog page object

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.

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 and sets the sub-key under the Visual Studio version specific root for storing a class's settings data.

A string is returned containing the sub-key of the Visual Studio version specific registry tree for containing the settings for a given dialog page..

Gets the window an instance of that it uses as its user interface.

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 this class.

This task provider is used to provide tasks for the Visual StudioError 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.

This class implements .

Creates an object.

An error object.

Gets and sets the hierarchy item associated with this task.

Returns the item associated with the task.

Maps objects to and from integer "cookies".

Creates an EventSinkCollection object.

Adds an event synchronization and returns its cookie.

Returns a uint specifying the event synchronization added. An Object to be added to the event synchronization collection .

Removes all event synchronizations.

Removes the specified event synchronization from the collection.

The object specifying the event to be removed.

Removes the event synchronization specified by the cookie integer returned from the method.

Specifies the particular event synchronization added in .

Updates the event synchronization associated with the given cookie.

A cookie specifying a particular event synchronization. An object to which the event sink is set.

Microsoft Internal Only.

Returns an .

Returns the total number of synchronizations in the collection.

Returns an int containing the number of events sinks in the collection.

Provides the ability to dynamically configure , including modifying their reflection accessible metadata.

Called by the Toolbox service to configure objects provided by specified assemblies.

[in] a 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.

Creates a new InstalledProductRegistrationAttribute instance to register your package with the Help About dialog box and enables it to present information on the Visual Studio splash screen.

This method, which is called to register this attribute with the given context, inserts registration information about a VSPackage when called by an external registration tool such as 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 the registration information about a VSPackage when called by an external registration tool such as regpkg.exe.

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.

Gets or sets a value that represents the resource ID of the icon associated with the product.

Gets or sets a value that contains a detailed description of the product.

A detailed description of the product.

Gets or sets a value for the product details resource ID.

Resource ID for the product details.

Gets or sets a value for the product ID.

The ID of the product.

Gets or sets a value for the name of the product.

The name of the product.

Gets or sets a value that represents the resource ID corresponding to the product name.

Resource ID corresponding to the product name.

Gets or sets a value indicating whether the product installation uses 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 supports the interface and false otherwise.

Gets or sets a value indicating whether the product installation uses the VSPackage ID.

The value is TRUE if the product installation uses the VSPackage 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]A interface provided by the environment to the VSPackage providing read access to the Visual Studio settings file.

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

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

[in]A 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.

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 Creates a reader for the specified file.

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 brows-able object. object.

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.

A managed code interop for the IOleDataObject interface.

Initializes a new instance of the class.

The underlying .

Initializes a new instance of the class.

The underlying .

Initializes a new instance of the class.

The underlying .

Establishes a connection between the data object and an advise sink.

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 advisory 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 a 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.

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.

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.

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.

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.

This overloaded constructor initializes the instance of OleMenuCmdEventArgs.

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

This class is an expansion of the .

Builds a new OleMenuCommand.

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

Builds a new OleMenuCommand.

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

Builds a new OleMenuCommand.

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

Builds a new OleMenuCommand.

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.

Builds a new OleMenuCommand.

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.

Builds a new OleMenuCommand.

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.

Event fired when a client requests the status of the command.

Allows a dynamic item command to match the subsequent items in its list. This must be overridden when implementing a menu via How to: Dynamically Add a Menu Item using DYNAMICITEMSTART.

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 value that represents 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.

An integer containing a mixture of status flags that reflects the state of this menu item.

Gets or sets 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.

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.

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

This constructor creates a new Package object.

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.

Returns if successful, otherwise returns 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 zero for a single instance tool window.

Releases the resources used by the object.

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

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

Returns 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 zero for a single instance tool window.

Returns 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.

Gets the requested dialog page.

An instance of the requested page. The type of dialog page to retrieve.

Gets the requested output window.

Returns 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.

Called when the VSPackage is loaded by Visual Studio.

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.

Internal implementation of the Close method.

Enables a VSPackage to participate in the automation object model.

String containing the automation property name. Specifies 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.

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.

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.

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.

Registers an editor factory with Visual Studio.

The editor factory to register.

Registers a project factory with Visual Studio.

The project factory to register.

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.

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.

object 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. true if this service should be added to any parent service containers; otherwise, false. object 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.

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 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 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 user data storage for Visual Studio.

The path to user data storage.

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

A RegistryKey that can be used to store user data.

Gets a value indicating whether the package is being closed.

True if the package is being closed; 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.

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.

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

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

Creates a new .

The name of the automation object.

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. Any class derived from must implement this method.

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.

Retrieves 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 and 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.

The FactoryType property returns the value set in the by the factoryType parameter.

Returns the editor factory type.

The NameResourceID property returns the value of the resourceID set in the constructor.

Returns the editor factory name resource ID, specified in the resource file.

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

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.

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

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.

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 with tableGuid and nameResourceID values.

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.

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.

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.

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 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 the default paths to search for snippets.

Returns a string containing a list of paths to search for snippets.

OBSOLETE. Do no use.

This property is not used.

Informs Visual Studio about a language service property page.

Initializes a new instance of the class.

[in] The registry key to create. This can be a path of keys, for example, "formatting\\indent". [in] The name of the language. This name is used in the registry for registry key and entry names. [in] A string containing a localized name. This string can alternatively specify a resource ID in the form "#dd" where "dd" is a decimal number. For example, "#104".

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.

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 localized name as a resource ID encoded in a string.

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

Returns the registry key to be created.

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

Determines the GUID of the option page as a string.

Returns a string that contains the GUID of the property page.

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.

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.

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.

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

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

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 sub-category. The localized resource ID of the Tools Options page category. The canonical unlocalized name of the Tools Options page sub-category. The canonical unlocalized name of the Tools Options page category.

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

A string containing the canonical unlocalized name of the Tools Options page's category.

Gets the resource ID for a Tools Options page's name.

A short containing the resource ID for the localized Tools Options page category.

Gets or sets how aggregated Tools Options pages are to be used.

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

Gets the canonical unlocalized name of the Tools Options page's sub-category.

A string containing the canonical unlocalized name of the Tools Options page's sub-category.

Gets the resource ID for a Tools Options page's name of a sub-category.

A short containing the resource ID for the localized Tools Options page category.

Gets the of the object implementing a Tools Options page.

A of the object implementing a ToolsOptions page.

Read-only property indicating if a Tools Options page implementation support implementation

A bool indicating if a Managed Package Framework based Tools Options page supports the Visual Studio automation model and can be accessed through the mechanism.

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

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

Gets the current instance of the class implementing a Tools Options page.

An object providing access to the current implementation of the class implementing a Tools Options page.

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

Creates a new instance of ProvideProfileAttribute indicating that a particular class implements Visual Studio settings support for a given VSPackage.

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, non-localized name of a Visual Studio settings category. The canonical, non-localized name used to identify the object implementing a Visual Studio settings category.

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

A string containing the canonical unlocalized name of the Visual Studio settings category created by the attribute.

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

A short containing the resource ID of the localized name of the Visual Studio settings category created by the attribute.

This argument is not currently implemented.

Gets a canonical unlocalized name of the object implementing a Visual Studio settings category.

A string containing the canonical, non-localized name used to identify an object implementing a Visual Studio settings category.

Gets the resource ID for the name of an object implementing a Visual Studio settings category.

A short containing the resource ID of the localized name used to identify the object implementing a Visual Studio settings category

Gets the of the object implementing a Visual Studio settings

A of the object used to implement a Visual Studio settings category.

ProvideProjectFactoryAttribute declares that a package provides a project factory.

This constructor creates a new object.

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 display string representing the project file extensions.

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

Unregister is called to un-register ProvideProjectFactoryAttribute attribute with the given context.

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

The DefaultProjectExtension property returns the value of the defaultProjectExtension set in the constructor.

Value of the defaultProjectExtension set in the constructor.

The DisplayProjectFileExtensionsResourceID property returns the value of the displayProjectFileExtensionsResourceID type set in the constructor.

Returns the value of the displayProjectFileExtensionsResourceID type set in the constructor.

The FactoryType property returns the value of the factoryType set in the constructor.

Returns the value of the factoryType set in the constructor.

Sets and gets the value for the Visual Studio language template.

Returns a string containing the registry key value of the language template.

The tree node name in the Create New Project and Add New Item dialogs.

Returns a string containing the project node name.

The PossibleProjectExtensions property returns the value of the possibleProjectExtensions set in the constructor.

Returns the possibleProjectExtensions value set in the constructor.

The ProjectTemplatesDirectory property returns the value of the projectTemplatesDirectory set in the constructor

Returns a string containing the path to the directory where the project templates are located.

ShowOnlySpecifiedTemplatesVsTemplate sets or gets the registry key that specifies the template to be shown in the New Project dialog.

Returns a string containing the value of the specific template.

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

Returns an int containing the sort priority for the New Project dialog.

TemplateGroupIDsVsTemplate gets or sets the value for the Visual Studio template group ID.

Returns a string containing the template group ID.

TemplateIDsVsTemplate gets or sets the value for the Visual Studio template ID.

Returns a string containing the template ID.

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

Must evaluate to the GUID of the class of the proferred type.

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.

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

Creates a new instance of for the specified format.

String containing the name of a supported format.

Represents the string containing the name of a supported clipboard format.

String containing the name of the clipboard format supported by the VSPackage the attribute was applied to.

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

Creates a new instance of .

[in] A reference to a object.

Returns the used to construct the .

Returns a of the used to construct the .

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

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.

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.

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 particular VSPackage as providing one or more dialog pages in the Customize Toolbox dialog page of the Visual Studio IDE.

Provides a new instance of , using the 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 numeric identifier of a native resource in a VSPackage's satellite dll containing the name for the tab of hosting this Customize Toolbox dialog page.

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

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

Provides 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] Indicates the Customize Toolbox dialog page placement in the pages of the Visual StudioCustomize Toolbox Dialog box. A value of zero indicates that no order is requested. [in] The of the class implementing the Customize Toolbox dialog page. This type must derive from the class. [in] A string containing a help key word used by the help system to index to the correct help topic information. [in] The numeric identifier of a native resource in a VSPackage's satellite dll containing the name for the tab of hosting this Customize Toolbox dialog page.

Returns a help key work associated with the Customize Toolbox dialog page.

A string containing the help key word used to obtain information about the Customize Toolbox dialog page.

Returns the resource ID of the name of the tab containing the Customize Toolbox dialog page.

A short containing the resource ID of the name of the tab containing the Customize Toolbox dialog page.

Returns the page order requested for the Customize Toolbox dialog page

A short containing the page order requested for the Customize Toolbox dialog page.

Returns the of the class implementing the Customize Toolbox dialog page.

A value corresponding to the value returned by the method of the class implementing the Customize Toolbox dialog page.

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

An referring to the instance of the class implementing the Customize Toolbox dialog page.

Notifies Visual Studio that a VSPackage owns a tool window.

Creates a new object.

The type of the tool window.

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.

Describes if one ore many instances of the Tool Window are allowed.

TRUE if multiple instances are allowed, otherwise FALSE.

Gets and sets the default docking style for the Tool Window.

The allowable docking styles are MDI, Float, Linked, Tabbed, AlwaysFloat and none.

Maps a tool window to one or more UI contexts so that the shell shows the window on a switch to one of those contexts and hides the window on a user switch from one of those mapped contexts.

This overloaded constructor sets the class of the ToolWindow and a GUID to associate with its visibility so that the shell automatically hides and shows it.

The class of the tool window. The GUID of the tool window that the automatic visibility behavior should be applied to.

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.

Returns 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.

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.

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.

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

Creates a new object when the type of the editor factory is known.

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 “.”.

Called to unregister 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.

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 a value that represents the name resource ID.

Name resource ID.

Gets the priority of this extension registration.

The priority for this editor for its file extension.

Gets or sets 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.

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 an extender with Visual Studio. This class cannot be inherited.

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.

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.

Returns a new 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.

Creates 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.

Called to register 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.

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.

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.

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

Creates 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.

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.

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 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.

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.

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 F:Microsoft.VisualStudio.Shell.SelectionContainer.SELECTED or F:Microsoft.VisualStudio.Shell.SelectionContainer.ALL 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 F:Microsoft.VisualStudio.Shell.SelectionContainer.ALL to indicate all members and F:Microsoft.VisualStudio.Shell.SelectionContainer.ELECTED 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.

Retrieves GUID-based services from the unmanaged service provider.

An instance of 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.

An instance of 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.

Retrieves 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 referenced.

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.

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.

Subclass this to implement your own 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.

This method can be overridden by the derived class to execute any code that needs to run after the creation of .

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.

Provides static helper methods for the managed package framework classes.

Returns the miscellaneous project files in a solution.

Returns the miscellaneous project hierarchy as an object. object used to retrieve the object.

Returns a project that a document is part of.

Returns the object of the project that contains the document. object used to retrieve the object. String form of the unique moniker identifier of the document in the project system. If the document is a file, you can simply specify the file extension for this parameter rather than the full path to the file (for example, .bmp or txt). In non-file cases, this identifier is often in the form of a URL.

Returns the text view object from sited in a window frame.

Returns the text view in a object. Returns null if the window frame is a code window that is not implemented as a text view. where the text view is sited.

Determines if a document is open.

Returns true and item hierarchy and window frame if the document is open with the given logical view. If logicalView is Guid.Empty, then this method returns true if any view is open, and false otherwise. GUID specifying the logical view. object. object. object. Full path to the document. Item id. The values are , or .

Opens a specified miscellaneous file in a specified editor.

File path of the requested document. Specifies the logical view of the editor. , for example. Specifies the specific type of window in which to open the editor. GUID of the editor in which to open the file. Name of the file. object.

Opens a document specified by a file path.

File path of the document. object.

Opens a specified document.

Logical view in which to open the document. object that is returned. object that is returned object. File path of the document. Item ID. Allowed values are , or .

Opens a specified document.