1 <?xml version="1.0" encoding="utf-8"?>
4 <name>Microsoft.VisualStudio.Shell.9.0</name>
7 <member name="T:Microsoft.VisualStudio.IEventHandler">
8 <summary>Provides the methods necessary to add, remove, and test for the existence of handlers in an event handler collection.</summary>
10 <member name="M:Microsoft.VisualStudio.IEventHandler.AddHandler(System.String)">
11 <summary>When implemented by a derived class, adds a named handler to an event handler collection.</summary>
13 <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> if the method succeeds, otherwise an error code.</returns>
14 <param name="bstrEventName">The name of the handler.</param>
16 <member name="M:Microsoft.VisualStudio.IEventHandler.GetHandledEvents">
17 <summary>When implemented by a derived class, returns an enumerator over all the handlers added by successive calls to <see cref="M:Microsoft.VisualStudio.IEventHandler.AddHandler(System.String)" />.</summary>
19 <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> if the method succeeds, otherwise an error code.</returns>
21 <member name="M:Microsoft.VisualStudio.IEventHandler.HandlesEvent(System.String)">
22 <summary>When implemented by a derived class, determines whether a named handler is in the event handler collection.</summary>
23 <returns>true if the handler is in the underlying handler collection, otherwise false.</returns>
24 <param name="bstrEventName">The name of the evaluated handler.</param>
26 <member name="M:Microsoft.VisualStudio.IEventHandler.RemoveHandler(System.String)">
27 <summary>When implemented by a derived class, removes a named handler from the collection of event handlers.</summary>
29 <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> if the method succeeds, otherwise an error code.</returns>
30 <param name="bstrEventName">The name of the event handler to remove.</param>
32 <member name="T:Microsoft.VisualStudio.Win32Methods">
33 <summary>Imports some Win32 window management functions.</summary>
35 <member name="M:Microsoft.VisualStudio.Win32Methods.#ctor">
36 <summary>Initializes a new instance of the class.</summary>
38 <member name="M:Microsoft.VisualStudio.Win32Methods.IsDialogMessageA(System.IntPtr,Microsoft.VisualStudio.OLE.Interop.MSG@)">
39 <summary>Determines if a message is intended for the specified dialog box, and if so processes the message.</summary>
40 <returns>true if the message has been processed, otherwise false.</returns>
41 <param name="hDlg">A handle to the child window.</param>
42 <param name="msg">The message in question.</param>
44 <member name="M:Microsoft.VisualStudio.Win32Methods.SetParent(System.IntPtr,System.IntPtr)">
45 <summary>Changes the parent window of the specified child window.</summary>
46 <returns>If the function succeeds, a handle to the previous parent window, otherwise null.</returns>
47 <param name="hWnd">A handle to the child window that should receive a new parent.</param>
48 <param name="hWndParent">A handle to the new parent window.</param>
50 <member name="T:Microsoft.VisualStudio.Shell.DefaultRegistryRootAttribute">
51 <summary>Defines the default registry root used to register VSPackage information. This class cannot be inherited.</summary>
53 <member name="M:Microsoft.VisualStudio.Shell.DefaultRegistryRootAttribute.#ctor(System.String)">
54 <summary>Initializes a new <see cref="T:Microsoft.VisualStudio.Shell.DefaultRegistryRootAttribute" /> object with the given registry root.</summary>
55 <param name="root">The default registry root used to register VSPackage information.</param>
56 <exception cref="T:System.ArgumentNullException">The constructor throws an <see cref="T:System.ArgumentNullException" /> if the root argument is null.</exception>
58 <member name="P:Microsoft.VisualStudio.Shell.DefaultRegistryRootAttribute.Root">
59 <summary>Gets the value of the default registry root for the VSPackage.</summary>
60 <returns>The value of the default registry root for the VSPackage.</returns>
62 <member name="T:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar">
63 <summary>Use this class to implement modal forms in Visual Studio. The implementation enables the form to host a Visual Studio command bar so that it participates in standard command routing.</summary>
65 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.#ctor">
66 <summary>Initializes a new instance of the class.</summary>
68 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.#ctor(System.IServiceProvider)">
69 <summary>Initializes a new instance of the class and sets the service provider.</summary>
70 <param name="sp">The service provider that the window can subsequently query to retrieve Visual Studio services.</param>
72 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.#ctor(System.IServiceProvider,System.Windows.Forms.Control)">
73 <summary>Initializes a new instance of the class and sets the service provider and the control that is contained by the form.</summary>
74 <param name="sp">The service provider that the window can subsequently query to retrieve Visual Studio services.</param>
75 <param name="contained">The control that is contained by the form.</param>
77 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.#ctor(System.IServiceProvider,System.Windows.Forms.Control,Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget)">
78 <summary>Initializes a new instance <see cref="T:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar" /> with its contained control, and an <see cref="T:Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget" /> implementation that is in addition to the one owned by the <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCommandService" />.</summary>
79 <param name="sp">The <see cref="T:System.IServiceProvider" />.</param>
80 <param name="contained">The <see cref="T:System.Windows.Forms.Control" /> that is to be contained.</param>
81 <param name="parentCommandTarget">The parent <see cref="T:Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget" />.</param>
83 <member name="P:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.CommandService">
84 <summary>Returns the command service that is used to check the status or execute the commands on the toolbar.</summary>
86 <see cref="T:System.ComponentModel.Design.IMenuCommandService" />.</returns>
88 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.Dispose(System.Boolean)">
89 <summary>Explicitly called to release resources.</summary>
90 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
92 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.Microsoft#VisualStudio#Shell#Interop#IVsToolWindowToolbar#GetBorder(Microsoft.VisualStudio.OLE.Interop.RECT[])">
93 <summary>Returns the border information for a tool window.</summary>
94 <returns>If the method succeeds, it returns S_OK. If it fails, it returns an error code.</returns>
95 <param name="rect">Pointer to the location and size of the tool window border.</param>
97 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.Microsoft#VisualStudio#Shell#Interop#IVsToolWindowToolbar#SetBorderSpace(Microsoft.VisualStudio.OLE.Interop.RECT[])">
98 <summary>Stores toolbar information and resizes the main pane to leave room for the command bar.</summary>
99 <returns>If the method succeeds, <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK;" /> otherwise, an error code.</returns>
100 <param name="rect">The new desired bounds.</param>
102 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.SetSite(System.IServiceProvider)">
103 <summary>Sets the site for this window.</summary>
104 <param name="sp">The service provider.</param>
106 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.ShowDialog">
107 <summary>Shows a dialog.</summary>
109 <see cref="T:System.Windows.Forms.DialogResult" />.</returns>
111 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.System#IServiceProvider#GetService(System.Type)">
112 <summary>Gets the service of the specified type.</summary>
113 <returns>An object that represents the requested service.</returns>
114 <param name="serviceType">The type of service requested.</param>
116 <member name="M:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.System#Windows#Forms#IMessageFilter#PreFilterMessage(System.Windows.Forms.Message@)">
117 <summary>Filters mouse messages before they are dispatched.</summary>
118 <returns>true if the message was filtered and not dispatched, false if it was dispatched.</returns>
119 <param name="m">A message from the toolbar.</param>
121 <member name="P:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.ToolbarHost">
122 <summary>Returns the corresponding <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsToolWindowToolbarHost" />.</summary>
124 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsToolWindowToolbarHost" />.</returns>
126 <member name="P:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.ToolbarID">
127 <summary>Gets or sets the command ID of the toolbar that is contained in this dialog box.</summary>
128 <returns>The command ID of the toolbar that is contained in this dialog box.</returns>
130 <member name="P:Microsoft.VisualStudio.Shell.DialogContainerWithToolbar.ToolbarLocation">
131 <summary>Gets and sets the value of the enumeration that describes the toolbar location.</summary>
132 <returns>The enumeration is defined as follows. Copy Codetypedef enum {VSTWT_LEFT, VSTWT_TOP, VSTWT_RIGHT, VSTWT_BOTTOM} VSTWT_LOCATION;
133 This corresponds to toolbar locations of left, top, right, and bottom.</returns>
135 <member name="T:Microsoft.VisualStudio.Shell.DialogPage.ApplyKind">
136 <summary>An enumeration that describes dialog page apply behavior.</summary>
138 <member name="F:Microsoft.VisualStudio.Shell.DialogPage.ApplyKind.Apply">
139 <summary>Allows the changes to be applied</summary>
141 <member name="F:Microsoft.VisualStudio.Shell.DialogPage.ApplyKind.Cancel">
142 <summary>Cancels the apply event and navigates to the page cancelling the event.</summary>
144 <member name="F:Microsoft.VisualStudio.Shell.DialogPage.ApplyKind.CancelNoNavigate">
145 <summary>Cancels the apply event and returns the active page, not the page canceling the event.</summary>
147 <member name="T:Microsoft.VisualStudio.Shell.EventSinkCollection">
148 <summary>Maps objects to and from event "cookies" that represent a client's registration with an event provider. </summary>
150 <member name="M:Microsoft.VisualStudio.Shell.EventSinkCollection.#ctor">
151 <summary>Initializes a new instance of an <see cref="T:Microsoft.VisualStudio.Shell.EventSinkCollection" /> object.</summary>
153 <member name="M:Microsoft.VisualStudio.Shell.EventSinkCollection.Add(System.Object)">
154 <summary>Adds an event and returns its cookie.</summary>
155 <returns>The cookie of the added event.</returns>
156 <param name="o">An object to be added to the event collection.</param>
158 <member name="M:Microsoft.VisualStudio.Shell.EventSinkCollection.Clear">
159 <summary>Removes all event cookies.</summary>
161 <member name="P:Microsoft.VisualStudio.Shell.EventSinkCollection.Count">
162 <summary>Gets the total number of event cookies in the collection.</summary>
163 <returns>The number of cookies in the collection.</returns>
165 <member name="P:Microsoft.VisualStudio.Shell.EventSinkCollection.Item(System.UInt32)">
166 <summary>Gets or sets the specified cookie from the collection.</summary>
167 <returns>The cookie.</returns>
168 <param name="cookie">The cookie to get.</param>
170 <member name="M:Microsoft.VisualStudio.Shell.EventSinkCollection.Remove(System.Object)">
171 <summary>Removes the specified event cookie from the collection.</summary>
172 <param name="obj">The event cookie to be removed.</param>
174 <member name="M:Microsoft.VisualStudio.Shell.EventSinkCollection.RemoveAt(System.UInt32)">
175 <summary>Removes the event cookie.</summary>
176 <param name="cookie">The event cookie. </param>
178 <member name="M:Microsoft.VisualStudio.Shell.EventSinkCollection.SetAt(System.UInt32,System.Object)">
179 <summary>Updates the event associated with the given cookie.</summary>
180 <param name="cookie">A cookie specifying an event.</param>
181 <param name="value">The value to which the event sink is set.</param>
183 <member name="M:Microsoft.VisualStudio.Shell.EventSinkCollection.System#Collections#IEnumerable#GetEnumerator">
184 <summary>Microsoft Internal Only.</summary>
185 <returns>Returns an <see cref="T:System.Collections.IEnumerator" />.</returns>
187 <member name="T:Microsoft.VisualStudio.Shell.IProfileManager">
188 <summary>Interface implemented by classes supporting VSPackages by persisting their state information through the Visual Studio settings mechanism.</summary>
190 <member name="M:Microsoft.VisualStudio.Shell.IProfileManager.LoadSettingsFromStorage">
191 <summary>Reads a VSPackage's configuration from local storage (typically the registry) and updates its state.</summary>
193 <member name="M:Microsoft.VisualStudio.Shell.IProfileManager.LoadSettingsFromXml(Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader)">
194 <summary>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.</summary>
195 <param name="reader">[in] An <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader" /> interface provided by the environment to the VSPackage providing read access to the Visual Studio settings file.</param>
197 <member name="M:Microsoft.VisualStudio.Shell.IProfileManager.ResetSettings">
198 <summary>Resets the user settings.</summary>
200 <member name="M:Microsoft.VisualStudio.Shell.IProfileManager.SaveSettingsToStorage">
201 <summary>Writes a VSPackage's configuration to local storage (typically the registry) following state update.</summary>
203 <member name="M:Microsoft.VisualStudio.Shell.IProfileManager.SaveSettingsToXml(Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter)">
204 <summary>Writes a VSPackage's configuration to disk using the Visual Studio settings mechanism when an import option of the Import/Export Settings command on the IDE’s Tools menu is selected by a user.</summary>
205 <param name="writer">[in] An <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter" /> interface provided by the environment to the VSPackage providing write access to the Visual Studio settings file.</param>
207 <member name="T:Microsoft.VisualStudio.Shell.MsiComponentIdAttribute">
208 <summary>Defines the Windows Installer component ID. The component ID is used by the Windows Installer to indicate the installation path to the VSPackage.</summary>
210 <member name="M:Microsoft.VisualStudio.Shell.MsiComponentIdAttribute.#ctor(System.String)">
211 <summary>This constructor creates a new MsiComponentIdAttribute object.</summary>
212 <param name="id">The Windows Installer component ID. The MSI component registration ID is used to indicate the installation path to the component within the Windows Installer.</param>
214 <member name="P:Microsoft.VisualStudio.Shell.MsiComponentIdAttribute.Id">
215 <summary>The Id property returns a string containing the Windows Installer component registration ID.</summary>
216 <returns>Returns a string containing the Windows Installer component registration ID.</returns>
218 <member name="T:Microsoft.VisualStudio.Shell.MsiTokenAttribute">
219 <summary>Defines a token string for the MSI installer.</summary>
221 <member name="M:Microsoft.VisualStudio.Shell.MsiTokenAttribute.#ctor(System.String,System.String)">
222 <summary>Creates an MsiTokenAttribute object.</summary>
223 <param name="name">Name of the MsiTokenAttribute.</param>
224 <param name="value">Value of the MsiTokenAttribute.</param>
226 <member name="P:Microsoft.VisualStudio.Shell.MsiTokenAttribute.Name">
227 <summary>Returns the MsiTokenAttribute name.</summary>
228 <returns>Returns a string containing the MsiTokenAttribute name.</returns>
230 <member name="P:Microsoft.VisualStudio.Shell.MsiTokenAttribute.Value">
231 <summary>Returns the MsiTokenAttribute value.</summary>
232 <returns>Returns a string containing the MsiTokenAttribute value.</returns>
234 <member name="T:Microsoft.VisualStudio.Shell.OleMenuCmdEventArgs">
235 <summary>The set of arguments passed to an <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCommand" /> object when the <see cref="M:Microsoft.VisualStudio.Shell.OleMenuCommand.Invoke(System.Object)" /> function is called.</summary>
237 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCmdEventArgs.#ctor(System.Object,System.IntPtr)">
238 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCmdEventArgs" /> the specified in and out parameters.</summary>
239 <param name="inParam">The input parameters to the command function.</param>
240 <param name="outParam">A pointer to the parameter returned by the function.</param>
242 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCmdEventArgs.#ctor(System.Object,System.IntPtr,Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT)"></member>
243 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCmdEventArgs.InValue">
244 <summary>Gets the in parameters to the command.</summary>
245 <returns>The in parameters to the command.</returns>
247 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCmdEventArgs.Options"></member>
248 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCmdEventArgs.OutValue">
249 <summary>Gets a pointer to the parameter used as output by the command function.</summary>
250 <returns>A pointer to the out parameter.</returns>
252 <member name="T:Microsoft.VisualStudio.Shell.OleMenuCommand">
253 <summary>This class is an expansion of the <see cref="T:System.ComponentModel.Design.MenuCommand" /> class.</summary>
255 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.#ctor(System.EventHandler,System.ComponentModel.Design.CommandID)">
256 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCommand" /> for the specified command.</summary>
257 <param name="invokeHandler">The event handler called to execute the command.</param>
258 <param name="id">ID of the command.</param>
260 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.#ctor(System.EventHandler,System.ComponentModel.Design.CommandID,System.String)">
261 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCommand" /> for the specified command.</summary>
262 <param name="invokeHandler">The event handler called to execute the command.</param>
263 <param name="id">ID of the command.</param>
264 <param name="Text">The text of the command.</param>
266 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.#ctor(System.EventHandler,System.EventHandler,System.ComponentModel.Design.CommandID)">
267 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCommand" /> for the specified command with the specified invocation and status handlers.</summary>
268 <param name="invokeHandler">The event handler called to execute the command.</param>
269 <param name="changeHandler"></param>
270 <param name="id">ID of the command.</param>
272 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.#ctor(System.EventHandler,System.EventHandler,System.ComponentModel.Design.CommandID,System.String)">
273 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCommand" /> for the specified command with the specified invocation and status handlers.</summary>
274 <param name="invokeHandler">The event handler called to execute the command.</param>
275 <param name="changeHandler"></param>
276 <param name="id">ID of the command.</param>
277 <param name="Text">The text of the command.</param>
279 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.#ctor(System.EventHandler,System.EventHandler,System.EventHandler,System.ComponentModel.Design.CommandID)">
280 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCommand" /> for the specified command with the specified pre-QueryStatus, invocation, and status handlers.</summary>
281 <param name="invokeHandler">The event handler called to execute the command.</param>
282 <param name="changeHandler"></param>
283 <param name="beforeQueryStatus">Event handler called when a client requests the command status.</param>
284 <param name="id">ID of the command.</param>
286 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.#ctor(System.EventHandler,System.EventHandler,System.EventHandler,System.ComponentModel.Design.CommandID,System.String)">
287 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.OleMenuCommand" /> for the specified command with the specified pre-QueryStatus, invocation, and status handlers.</summary>
288 <param name="invokeHandler">The event handler called to execute the command.</param>
289 <param name="changeHandler"></param>
290 <param name="beforeQueryStatus">Event handler called when a client requests the command status.</param>
291 <param name="id">ID of the command.</param>
292 <param name="Text">The text of the command.</param>
294 <member name="E:Microsoft.VisualStudio.Shell.OleMenuCommand.BeforeQueryStatus">
295 <summary>Called when a client requests the status of the command.</summary>
297 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.DynamicItemMatch(System.Int32)">
298 <summary>Allows a dynamic item command to match the subsequent items in its list. </summary>
299 <returns>true if the dynamic item found a match, otherwise false.</returns>
300 <param name="cmdId">The command ID.</param>
302 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.Invoke(System.Object)">
303 <summary>Executes the command.</summary>
304 <param name="inArg">The parameter passed to the command.</param>
306 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.Invoke(System.Object,System.IntPtr)">
307 <summary>Executes the command.</summary>
308 <param name="inArg">The parameter passed to the command.</param>
309 <param name="outArg">The parameter returned by the command.</param>
311 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommand.Invoke(System.Object,System.IntPtr,Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT)"></member>
312 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCommand.MatchedCommandId">
313 <summary>Gets or sets a the command ID.</summary>
314 <returns>The command ID that was most recently used to match this command.</returns>
316 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCommand.OleStatus">
317 <summary>Gets the OLE command status code for this menu item.</summary>
318 <returns>The status flags that reflects the state of this menu item.</returns>
320 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCommand.ParametersDescription">
321 <summary>Gets or sets the description of the parameters of the command.</summary>
322 <returns>The description of the parameters of the command.</returns>
324 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCommand.Text">
325 <summary>Gets or sets the text for the command.</summary>
326 <returns>The text for the command.</returns>
328 <member name="T:Microsoft.VisualStudio.Shell.OleMenuCommandService">
329 <summary>This class derives from the <see cref="T:System.ComponentModel.Design.MenuCommandService" /> class and implements <see cref="T:Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget" />. <see cref="T:System.ComponentModel.Design.MenuCommandService" /> is the managed class used to add handlers for menu commands and to define verbs.</summary>
331 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommandService.#ctor(System.IServiceProvider)">
332 <summary>Creates a new menu command service.</summary>
333 <param name="serviceProvider">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 <see cref="T:System.ComponentModel.Design.DesignSurface" /> instance).</param>
335 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommandService.#ctor(System.IServiceProvider,Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget)">
336 <summary>Creates a new menu command service.</summary>
337 <param name="serviceProvider">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 <see cref="T:System.ComponentModel.Design.DesignSurface" /> instance).</param>
338 <param name="parentCommandTarget">Allows the service to defer command searching to a parent IOleCommandTarget if the command is not found in this object.</param>
339 <exception cref="T:System.ArgumentNullException">Throws an <see cref="T:System.ArgumentNullException" /> if <paramref name="parentCommandTarget" /> is null.</exception>
341 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommandService.GlobalInvoke(System.ComponentModel.Design.CommandID)">
342 <summary>Can be used to invoke any command within Visual Studio.</summary>
343 <returns>true if the invocation succeeded; otherwise, false.</returns>
344 <param name="commandID">The command ID of the command to search for and execute.</param>
346 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommandService.GlobalInvoke(System.ComponentModel.Design.CommandID,System.Object)">
347 <summary>Can be used to invoke any command within Visual Studio.</summary>
348 <returns>true if the invocation succeeded; otherwise, false.</returns>
349 <param name="commandID">The command ID of the command to search for and execute.</param>
350 <param name="arg">The optional command argument.</param>
352 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommandService.Microsoft#VisualStudio#OLE#Interop#IOleCommandTarget#Exec(System.Guid@,System.UInt32,System.UInt32,System.IntPtr,System.IntPtr)">
353 <summary>Executes the selected command.</summary>
354 <returns>An HRESULT code indicating the success or failure of the call. The following HRESULTs may be returned:ValueDescription<see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />The command was successfully invoked.<see cref="F:Microsoft.VisualStudio.OLE.Interop.Constants.OLECMDERR_E_UNKNOWNGROUP" />The group guid did not match the commandID’s Guid property for any command or verb.<see cref="F:Microsoft.VisualStudio.OLE.Interop.Constants.OLECMDERR_E_NOTSUPPORTED" />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.</returns>
355 <param name="guidGroup">System.Guid <paramref name="guidGroup" />. The menu group. This implementation maps the group to CommandID.Guid.</param>
356 <param name="nCmdId">System.UInt32 <paramref name="nCmdId" />. The ID code of the command. This implementation maps nCmdId to CommandID.ID.</param>
357 <param name="nCmdExcept">System.UInt32 <paramref name="nCmdExcept" />. Count of command options. This implementation ignores this parameter.</param>
358 <param name="pIn">System.Object[] <paramref name="pIn" />. Actual command options. This implementation ignores this parameter.</param>
359 <param name="vOut">System.IntPtr <paramref name="vOut" />. Output data for the command. This implementation ignores this parameter.</param>
361 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommandService.Microsoft#VisualStudio#OLE#Interop#IOleCommandTarget#QueryStatus(System.Guid@,System.UInt32,Microsoft.VisualStudio.OLE.Interop.OLECMD[],System.IntPtr)">
362 <summary>Sets command status.</summary>
363 <returns>An HRESULT code indicating the success or failure of the call. The following HRESULTs may be returned:ValueDescription<see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />The command was successfully invoked.<see cref="F:Microsoft.VisualStudio.OLE.Interop.Constants.OLECMDERR_E_UNKNOWNGROUP" />The group guid did not match the commandID’s Guid property for any command or verb.<see cref="F:Microsoft.VisualStudio.OLE.Interop.Constants.OLECMDERR_E_NOTSUPPORTED" />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.</returns>
364 <param name="guidGroup">System.Guid <paramref name="guidGroup" />. The menu group. This implementation maps the group to CommandID.Guid.</param>
365 <param name="nCmdId">System.UInt32 <paramref name="nCmdId" />. The ID code of the command. This implementation maps nCmdId to CommandID.ID.</param>
366 <param name="oleCmd">Microsoft.OLE.Interop._tagOLECMD[] <paramref name="oleCmd" />. A command structure that contains data about the status of the command.</param>
367 <param name="oleText">System.IntPtr<paramref name=" oleText" />. A pointer to a text BSTR. If the command is a verb the name of the verb will be filled in here.</param>
369 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommandService.OnCommandsChanged(System.ComponentModel.Design.MenuCommandsChangedEventArgs)">
370 <summary>Called by a menu command when its status has changed.</summary>
371 <param name="e">Signifies that there has been a change in <see cref="T:System.Windows.Forms.Design.MenuCommands" /> (added or removed) on the related object.</param>
373 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCommandService.ParentTarget"></member>
374 <member name="P:Microsoft.VisualStudio.Shell.OleMenuCommandService.ServiceProvider"></member>
375 <member name="M:Microsoft.VisualStudio.Shell.OleMenuCommandService.ShowContextMenu(System.ComponentModel.Design.CommandID,System.Int32,System.Int32)">
376 <summary>Shows the shortcut menu with the given command ID at the given location.</summary>
377 <param name="menuID">A command ID representing the shortcut menu to show.</param>
378 <param name="x">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.</param>
379 <param name="y">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.</param>
380 <exception cref="T:System.ArgumentNullException">
381 <paramref name="menuID" /> is null.</exception>
383 <member name="T:Microsoft.VisualStudio.Shell.Package">
384 <summary>Provides a managed implementation of the VSIP interfaces required to create a fully functional VSPackage.</summary>
386 <member name="M:Microsoft.VisualStudio.Shell.Package.#ctor">
387 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.Package" />.</summary>
389 <member name="M:Microsoft.VisualStudio.Shell.Package.AddOptionKey(System.String)">
390 <summary>Adds a user option key name into the list of option keys.</summary>
391 <param name="name">The name of the option key to add. An option key name must not have any periods in it.</param>
393 <member name="P:Microsoft.VisualStudio.Shell.Package.ApplicationRegistryRoot">
394 <summary>Gets the root registry key of the current Visual Studio registry hive.</summary>
395 <returns>The root <see cref="T:Microsoft.Win32.RegistryKey" /> of the Visual Studio registry hive.</returns>
397 <member name="M:Microsoft.VisualStudio.Shell.Package.CreateInstance(System.Guid@,System.Guid@,System.Type)">
398 <summary>Creates the specified COM object using the Visual Studio's local registry CLSID object.</summary>
399 <returns>An instance of the created object.</returns>
400 <param name="clsid">The CLSID of the object to create.</param>
401 <param name="iid">The interface IID the object implements.</param>
402 <param name="type">The managed type of the object to return.</param>
404 <member name="M:Microsoft.VisualStudio.Shell.Package.CreateTool(System.Guid@)">
405 <summary>Enables derived classes to provide an implementation if necessary.</summary>
407 <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> if successful, otherwise an error code.</returns>
408 <param name="persistenceSlot">The GUID of the tool window that should be created.</param>
410 <member name="M:Microsoft.VisualStudio.Shell.Package.CreateToolWindow(System.Type,System.Int32)">
411 <summary>Creates a tool window of the specified type with the specified ID.</summary>
412 <returns>An instance of the requested tool window.</returns>
413 <param name="toolWindowType">The type of tool window to create.</param>
414 <param name="id">The tool window ID. This is 0 for a single-instance tool window.</param>
415 <exception cref="T:System.ArgumentNullException">
416 <paramref name="toolWindowType" /> is null.</exception>
417 <exception cref="T:System.ArgumentException">
418 <paramref name="id" /> is less than 0.<paramref name="toolWindowType" /> is not derived from <see cref="T:Microsoft.VisualStudio.Shell.ToolWindowPane" /> type.</exception>
420 <member name="M:Microsoft.VisualStudio.Shell.Package.Dispose(System.Boolean)">
421 <summary>Releases the resources used by the <see cref="T:Microsoft.VisualStudio.Shell.Package" /> object.</summary>
422 <param name="disposing">true if the object is being disposed, false if it is being finalized.</param>
424 <member name="M:Microsoft.VisualStudio.Shell.Package.FindToolWindow(System.Type,System.Int32,System.Boolean)">
425 <summary>Gets the tool window corresponding to the specified type and ID.</summary>
426 <returns>An instance of the requested tool window. If <paramref name="create" /> is false and the tool window does not exist, null is returned.</returns>
427 <param name="toolWindowType">The type of tool window to create.</param>
428 <param name="id">The tool window ID. This is 0 for a single-instance tool window.</param>
429 <param name="create">If true, the tool window is created if it does not exist.</param>
430 <exception cref="T:System.ArgumentNullException">
431 <paramref name="toolWindowType" /> is null.</exception>
432 <exception cref="T:System.ArgumentException">
433 <paramref name="toolWindowType" /> is not derived from <see cref="T:Microsoft.VisualStudio.Shell.ToolWindowPane" />.<paramref name="toolWindowType" /> does not have a public constructor .</exception>
435 <member name="M:Microsoft.VisualStudio.Shell.Package.GetAutomationObject(System.String)">
436 <summary>Gets the automation object for the VSPackage.</summary>
437 <returns>An instance of the automation object, or null if no automation support is available.</returns>
438 <param name="name">The name of the automation object to return. If <paramref name="name" /> is null, GetAutomationObject returns the default automation object for the VSPackage.</param>
439 <exception cref="T:System.NotImplementedException">Thrown by the base implementation of GetAutomationObject.</exception>
441 <member name="M:Microsoft.VisualStudio.Shell.Package.GetDialogPage(System.Type)">
442 <summary>Gets the requested dialog page.</summary>
443 <returns>An instance of the requested page.</returns>
444 <param name="dialogPageType">The type of dialog page to retrieve.</param>
445 <exception cref="T:System.ArgumentNullException">
446 <paramref name="dialogPageType" /> is null.</exception>
447 <exception cref="T:System.ArgumentException">
448 <paramref name="dialogPageType" /> is not derived from <see cref="T:Microsoft.VisualStudio.Shell.DialogPage" />.<paramref name="dialogPageType" /> does not have a public constructor.</exception>
450 <member name="M:Microsoft.VisualStudio.Shell.Package.GetGlobalService(System.Type)">
451 <summary>Gets a service proffered globally by Visual Studio or one of its packages. This is the same as calling GetService() on an instance of a package that proffers no services itself.</summary>
452 <returns>The service being requested if available, otherwise null.</returns>
453 <param name="serviceType">The type of the service requested.</param>
455 <member name="M:Microsoft.VisualStudio.Shell.Package.GetOutputPane(System.Guid,System.String)">
456 <summary>Gets the requested output window.</summary>
457 <returns>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsOutputWindowPane" /> interface. Returns null in case of failure.</returns>
458 <param name="page">The GUID corresponding to the pane. (See <see cref="T:Microsoft.VisualStudio.VSConstants" /> class for the GUIDs which correspond to output panes.)</param>
459 <param name="caption">The caption to create if the pane does not exist.</param>
461 <member name="M:Microsoft.VisualStudio.Shell.Package.GetProviderLocale">
462 <summary>Returns the locale associated with this service provider.</summary>
463 <returns>Returns the locale identifier for the service provider.</returns>
465 <member name="M:Microsoft.VisualStudio.Shell.Package.GetService(System.Type)">
466 <summary>Gets type-based services from the VSPackage service container.</summary>
467 <returns>An instance of the requested service, or null if the service could not be found.</returns>
468 <param name="serviceType">The type of service to retrieve.</param>
469 <exception cref="T:System.ArgumentNullException">
470 <paramref name="serviceType" /> is null.</exception>
472 <member name="M:Microsoft.VisualStudio.Shell.Package.Initialize">
473 <summary>Called when the VSPackage is loaded by Visual Studio.</summary>
475 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#OLE#Interop#IOleCommandTarget#Exec(System.Guid@,System.UInt32,System.UInt32,System.IntPtr,System.IntPtr)">
476 <summary>Executes a specified command or displays help for a command.</summary>
477 <returns>This method returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> if it succeeds, otherwise an error code. If no instance of <see cref="T:Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget" /> can be found, returns <see cref="F:Microsoft.VisualStudio.NativeMethods.OLECMDERR_E_NOTSUPPORTED" />.</returns>
478 <param name="guidGroup">The GUID specifying the command group to which the command belongs.</param>
479 <param name="nCmdId">The ID of the command.</param>
480 <param name="nCmdExcept">A pointer to an <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT" /> structure specifying how the command should be executed.</param>
481 <param name="pIn">A pointer to a VARIANTARG structure containing input arguments. Can be null.</param>
482 <param name="vOut">A pointer to a VARIANTARG structure to receive command output. Can be null. </param>
484 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#OLE#Interop#IOleCommandTarget#QueryStatus(System.Guid@,System.UInt32,Microsoft.VisualStudio.OLE.Interop.OLECMD[],System.IntPtr)">
485 <summary>Queries the object for the status of one or more commands generated by user interface events.</summary>
487 <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> if the method succeeded, otherwise an error code. This method returns <see cref="F:Microsoft.VisualStudio.NativeMethods.OLECMDERR_E_NOTSUPPORTED" /> if no instance of <see cref="T:Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget" /> can be found.</returns>
488 <param name="guidGroup">The GUID of the command group to which the command belongs.</param>
489 <param name="nCmdId">The ID of the command.</param>
490 <param name="oleCmd">An array of OLECMD structures representing the commands being queried.</param>
491 <param name="oleText">A pointer to an OLECMDTXT structure in which to return name and/or status information for a single command. Can be null to indicate that the caller does not need this information. </param>
493 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#OLE#Interop#IServiceProvider#QueryService(System.Guid@,System.Guid@,System.IntPtr@)">
494 <summary>Internal IServiceProvider implementation.</summary>
495 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise it returns an error code.</returns>
496 <param name="sid">GUID of the service.</param>
497 <param name="iid">GUID of the requested interface</param>
498 <param name="ppvObj">Pointer to the object requested.</param>
500 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPackage#Close">
501 <summary>Closes and disposes the package.</summary>
502 <returns>If the method succeeds, <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise an error code.</returns>
504 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPackage#GetAutomationObject(System.String,System.Object@)">
505 <summary>Gets an automation-friendly object for this package.</summary>
506 <returns>If the method succeeds, <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise an error code.</returns>
507 <param name="propName">String containing the automation property name.</param>
508 <param name="auto">[out] Returns the automation object.</param>
510 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPackage#GetPropertyPage(System.Guid@,Microsoft.VisualStudio.Shell.Interop.VSPROPSHEETPAGE[])">
511 <summary>Proffers access to the Tools menu Options and the property pages of the Customize Toolbox dialog boxes.</summary>
512 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise it returns an error code.</returns>
513 <param name="rguidPage">Unique identifier of the requested property page.</param>
514 <param name="ppage">Specifies the property page whose values are taken from the <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSPROPSHEETPAGE" /> structure.</param>
516 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPackage#QueryClose(System.Int32@)">
517 <summary>Called to ask the VSPackage if the Visual Studio shell can be closed.</summary>
518 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise it returns an error code.</returns>
519 <param name="close">Set <paramref name="canClose" /> to false if you want to prevent the shell from closing</param>
521 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPackage#ResetDefaults(System.UInt32)">
522 <summary>Resets Toolbox defaults.</summary>
523 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise it returns an error code.</returns>
524 <param name="grfFlags">Flags whose values are taken from the <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VSPKGRESETFLAGS" /> enumeration</param>
526 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPackage#SetSite(Microsoft.VisualStudio.OLE.Interop.IServiceProvider)">
527 <summary>Initializes the VSPackage in the Visual Studio environment.</summary>
528 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
530 <see cref="T:Microsoft.VisualStudio.OLE.Interop.IServiceProvider" /> object.</param>
532 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPersistSolutionOpts#LoadUserOptions(Microsoft.VisualStudio.Shell.Interop.IVsSolutionPersistence,System.UInt32)">
533 <summary>Loads user options for a given solution.</summary>
534 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
535 <param name="pPersistance">
536 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsSolutionPersistence" /> object.</param>
537 <param name="options">User options whose value is taken from the <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VSLOADUSEROPTS" /></param>
539 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPersistSolutionOpts#ReadUserOptions(Microsoft.VisualStudio.OLE.Interop.IStream,System.String)">
540 <summary>Reads user options for a given solution.</summary>
541 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
542 <param name="pStream">
543 <see cref="T:Microsoft.VisualStudio.OLE.Interop.IStream" /> object from which the VSPackage should read the user-specific options</param>
544 <param name="pszKey">Name of the stream.</param>
546 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPersistSolutionOpts#SaveUserOptions(Microsoft.VisualStudio.Shell.Interop.IVsSolutionPersistence)">
547 <summary>Saves user options for a given solution.</summary>
548 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
549 <param name="pPersistance">
550 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsSolutionPersistence" /> object.</param>
552 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsPersistSolutionOpts#WriteUserOptions(Microsoft.VisualStudio.OLE.Interop.IStream,System.String)">
553 <summary>Writes user options for a given solution.</summary>
554 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
555 <param name="pStream">
556 <see cref="T:Microsoft.VisualStudio.OLE.Interop.IStream" /> object to which the VSPackage writes the user-specific options.</param>
557 <param name="pszKey">Name of the stream.</param>
559 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsToolWindowFactory#CreateToolWindow(System.Guid@,System.UInt32)">
560 <summary>Creates a tool window of the specified type with the specified ID.</summary>
561 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
562 <param name="toolWindowType">Type of the window to be created.</param>
563 <param name="id">Instance ID</param>
565 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsUserSettings#ExportSettings(System.String,Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter)">
566 <summary>This method implements the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUserSettings" /> Interface used to manage profiles and import/export settings to XML files.</summary>
567 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
568 <param name="strPageGuid">GUID of the page.</param>
569 <param name="writer">
570 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter" /> object.</param>
572 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsUserSettings#ImportSettings(System.String,Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader,System.UInt32,System.Int32@)">
573 <summary>Retrieves a VSPackage's configuration using the Visual Studio settings mechanism when a user selects the import option of the Import/Export Settings feature on the IDE’s Tools menu. This method is part of the implementation of the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUserSettings" /> interface used to manage profiles and import/export settings to XML files.</summary>
574 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
575 <param name="strPageGuid">GUID of the page.</param>
576 <param name="reader">
577 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader" /> object.</param>
578 <param name="flags">Values from the <see cref="T:Microsoft.VisualStudio.Shell.Interop.__UserSettingsFlags" /> returned by the shell, specifying how the settings are to be processed.</param>
579 <param name="restartRequired">true if the Visual Studio IDE must be restarted.</param>
581 <member name="M:Microsoft.VisualStudio.Shell.Package.Microsoft#VisualStudio#Shell#Interop#IVsUserSettingsMigration#MigrateSettings(Microsoft.VisualStudio.Shell.Interop.IVsSettingsReader,Microsoft.VisualStudio.Shell.Interop.IVsSettingsWriter,System.String)"></member>
582 <member name="M:Microsoft.VisualStudio.Shell.Package.OnLoadOptions(System.String,System.IO.Stream)">
583 <summary>Invoked by the package class when there are options to be read out of the solution file.</summary>
584 <param name="key">The name of the option key to load.</param>
585 <param name="stream">The stream to load the option data from.</param>
587 <member name="M:Microsoft.VisualStudio.Shell.Package.OnSaveOptions(System.String,System.IO.Stream)">
588 <summary>Invoked by the <see cref="T:Microsoft.VisualStudio.Shell.Package" /> class when there are options to be saved to the solution file. </summary>
589 <param name="key">The name of the option key to save.</param>
590 <param name="stream">The stream to save the option data to.</param>
592 <member name="M:Microsoft.VisualStudio.Shell.Package.ParseToolboxResource(System.IO.TextReader,System.Guid)">
593 <summary>Parses an embedded text resource of appropriate format for information about which items should be added to the Toolbox.</summary>
594 <param name="resourceData">A text reader that provides toolbox item data in the format described in Remarks.</param>
595 <param name="packageGuid">The GUID of the VSPackage.</param>
597 <member name="M:Microsoft.VisualStudio.Shell.Package.ParseToolboxResource(System.IO.TextReader,System.Resources.ResourceManager)">
598 <summary>Parses an embedded text resource of appropriate format for information about which items should be added to the Toolbox.</summary>
599 <param name="resourceData">A text reader that provides toolbox item data in the format described in Remarks.</param>
600 <param name="localizedCategories">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.</param>
602 <member name="M:Microsoft.VisualStudio.Shell.Package.QueryClose(System.Boolean@)">
603 <summary>Called to ask the package if the shell can be closed.</summary>
605 <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> if the method succeeded, otherwise an error code.</returns>
606 <param name="canClose">[out] Returns true if the shell can be closed, otherwise false.</param>
608 <member name="M:Microsoft.VisualStudio.Shell.Package.RegisterEditorFactory(Microsoft.VisualStudio.Shell.Interop.IVsEditorFactory)">
609 <summary>Registers an editor factory with Visual Studio.</summary>
610 <param name="factory">The editor factory to register.</param>
611 <exception cref="T:System.ArgumentNullException">
612 <paramref name="factory" /> is null.</exception>
614 <member name="M:Microsoft.VisualStudio.Shell.Package.RegisterProjectFactory(Microsoft.VisualStudio.Shell.Interop.IVsProjectFactory)">
615 <summary>Registers a project factory with Visual Studio.</summary>
616 <param name="factory">The project factory to register.</param>
617 <exception cref="T:System.ArgumentNullException">
618 <paramref name="factory" /> is null.</exception>
620 <member name="M:Microsoft.VisualStudio.Shell.Package.ShowOptionPage(System.Type)">
621 <summary>Displays a specified tools options page.</summary>
622 <param name="optionsPageType">The options page to open. The options page is identified by the GUID of the <paramref name="optionsPageType" /> object passed in.</param>
623 <exception cref="T:System.ArgumentNullException">
624 <paramref name="optionsPageType" /> is null.</exception>
626 <member name="M:Microsoft.VisualStudio.Shell.Package.System#ComponentModel#Design#IServiceContainer#AddService(System.Type,System.ComponentModel.Design.ServiceCreatorCallback)">
627 <summary>Adds the given service to the VSPackage's service container.</summary>
628 <param name="serviceType">Type of service to add.</param>
629 <param name="callback">
630 <see cref="T:System.ComponentModel.Design.ServiceCreatorCallback" /> 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.</param>
632 <member name="M:Microsoft.VisualStudio.Shell.Package.System#ComponentModel#Design#IServiceContainer#AddService(System.Type,System.ComponentModel.Design.ServiceCreatorCallback,System.Boolean)">
633 <summary>Adds the given service to the service container by means of the specified <see cref="T:System.ComponentModel.Design.ServiceCreatorCallback" />.</summary>
634 <param name="serviceType">The type of service to add.</param>
635 <param name="callback">
636 <see cref="T:System.ComponentModel.Design.ServiceCreatorCallback" /> 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.</param>
637 <param name="promote">true if this service should be added to any parent service containers; otherwise, false.</param>
639 <member name="M:Microsoft.VisualStudio.Shell.Package.System#ComponentModel#Design#IServiceContainer#AddService(System.Type,System.Object)">
640 <summary>Adds the given service to the VSPackage's service container.</summary>
641 <param name="serviceType">Type of service to add.</param>
642 <param name="serviceInstance">Service object.</param>
644 <member name="M:Microsoft.VisualStudio.Shell.Package.System#ComponentModel#Design#IServiceContainer#AddService(System.Type,System.Object,System.Boolean)">
645 <summary>Adds the given service to the VSPackage's service container.</summary>
646 <param name="serviceType">Type of service to add.</param>
647 <param name="serviceInstance">Service object.</param>
648 <param name="promote">true if this service should be added to any parent service containers; otherwise, false.</param>
650 <member name="M:Microsoft.VisualStudio.Shell.Package.System#ComponentModel#Design#IServiceContainer#RemoveService(System.Type)">
651 <summary>Removes the given service type from the service container.</summary>
652 <param name="serviceType">The type of service to remove.</param>
654 <member name="M:Microsoft.VisualStudio.Shell.Package.System#ComponentModel#Design#IServiceContainer#RemoveService(System.Type,System.Boolean)">
655 <summary>Removes the given service type from the service container, and optionally promotes the removal of the service to parent service containers.</summary>
656 <param name="serviceType">The type of service to remove.</param>
657 <param name="promote">true to promote this request to any parent service containers; otherwise, false.</param>
659 <member name="M:Microsoft.VisualStudio.Shell.Package.System#IServiceProvider#GetService(System.Type)">
660 <summary>Gets the service of the specified type.</summary>
661 <returns>An object representing the requested service, or null if none can be found.</returns>
662 <param name="serviceType">The type of the service to get.</param>
664 <member name="E:Microsoft.VisualStudio.Shell.Package.ToolboxInitialized">
665 <summary>Event generated whenever Visual Studio initializes its Toolbox.</summary>
667 <member name="E:Microsoft.VisualStudio.Shell.Package.ToolboxUpgraded">
668 <summary>Event generated whenever Visual Studio upgrades its Toolbox.</summary>
670 <member name="P:Microsoft.VisualStudio.Shell.Package.UserDataPath">
671 <summary>Gets the path to user data storage for Visual Studio.</summary>
672 <returns>The path to user data storage.</returns>
674 <member name="P:Microsoft.VisualStudio.Shell.Package.UserLocalDataPath">
675 <summary>Gets the path to local user data storage for Visual Studio.</summary>
676 <returns>The path to local user data storage.</returns>
678 <member name="P:Microsoft.VisualStudio.Shell.Package.UserRegistryRoot">
679 <summary>Gets a registry key that can be used to store user data.</summary>
680 <returns>A <see cref="T:Microsoft.Win32.RegistryKey" /> that can be used to store user data.</returns>
682 <member name="P:Microsoft.VisualStudio.Shell.Package.Zombied">
683 <summary>Gets a value indicating whether the package in the process of shutdown.</summary>
684 <returns>true if the package is in the process of shutdown, otherwise false.</returns>
686 <member name="T:Microsoft.VisualStudio.Shell.PackageUtilities">
687 <summary>A set of static utilities for filenames, paths, enumeration/string conversions, images, and other functions.</summary>
689 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.ContainsInvalidFileNameChars(System.String)">
690 <summary>Determines whether or not a string contains characters that are invalid for file names or paths.</summary>
691 <returns>true if the string contains invalid characters, false if the string is a valid file name or path.</returns>
692 <param name="name">The file name or path.</param>
694 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.ConvertFromType``1(System.String,System.Globalization.CultureInfo)">
695 <summary>Converts a string to an enumeration using a converter.</summary>
696 <returns>The enumeration value.</returns>
697 <param name="value">The string value.</param>
698 <param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> of the string.</param>
699 <typeparam name="T"></typeparam>
701 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.ConvertToType``1(``0,System.Type,System.Globalization.CultureInfo)">
702 <summary>Converts a string to an enumeration type.</summary>
703 <returns>The enumeration type.</returns>
704 <param name="value">The enumeration to which the string is to be converted.</param>
705 <param name="typeToConvert">The value to convert.</param>
706 <param name="culture">A <see cref="T:System.Globalization.CultureInfo" /> object describing the culture to use to read localized strings.</param>
707 <typeparam name="T"></typeparam>
709 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.CopyUrlToLocal(System.Uri,System.String)">
710 <summary>Copies the specified file to the local project directory. </summary>
711 <param name="uri">The <see cref="T:System.Uri" /> to copy.</param>
712 <param name="local">The local resource to copy it to.</param>
714 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.CreateCAUUIDFromGuidArray(System.Guid[])">
715 <summary>Creates a CAUUID from a GUID array. </summary>
716 <returns>A <see cref="T:Microsoft.VisualStudio.OLE.Interop.CAUUID" /> structure.</returns>
717 <param name="guids">An array of GUIDs.</param>
719 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.EnsureOutputPath(System.String)">
720 <summary>Creates the directories necessary for the given path.</summary>
721 <param name="path">The path to create.</param>
723 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.GetImageList(System.IO.Stream)">
724 <summary>Creates an image list from the specified stream.</summary>
725 <returns>An <see cref="T:System.Windows.Forms.ImageList" /> containing a series of 16 by 16 pixel bitmaps with a magenta background color.</returns>
726 <param name="imageStream">The stream from which to extract the bitmaps.</param>
728 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.GetImageList(System.Object)">
729 <summary>Creates a list of bitmaps from the resource handle.</summary>
730 <returns>An <see cref="T:System.Windows.Forms.ImageList" /> containing a series of bitmaps.</returns>
731 <param name="imageListAsPointer">The handle of a resource.</param>
733 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.GetImageList(System.Reflection.Assembly,System.String[])">
734 <summary>Creates a list of bitmaps from the specified assembly and resource names.</summary>
735 <returns>An <see cref="T:System.Windows.Forms.ImageList" /> containing a series of 16 by 16 pixel bitmaps.</returns>
736 <param name="assembly">The assembly from which to get the resources.</param>
737 <param name="resourceNames">An array of resource names (representing bitmaps) in the assembly.</param>
739 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.GetIntPointerFromImage(System.Drawing.Image)">
740 <summary>Gets a pointer from a bitmap image.</summary>
741 <returns>An integer which serves as an <see cref="T:System.IntPtr" />.</returns>
743 <see cref="T:System.Drawing.Image" />.</param>
745 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.GetPathDistance(System.Uri,System.Uri)">
746 <summary>Calculates the distance between two paths.</summary>
747 <returns>The relative path.</returns>
748 <param name="uriBase">The base <see cref="T:System.Uri" />.</param>
749 <param name="uriRelativeTo">The relative <see cref="T:System.Uri" />.</param>
751 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.GetSystemAssemblyPath">
752 <summary>Gets the path of system assemblies.</summary>
753 <returns>The base directory for system assemblies.</returns>
755 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.IsFileNameInvalid(System.String)">
756 <summary>Determines whether or not the specified file name is invalid.</summary>
757 <returns>true if the file name is invalid, false if it is valid.</returns>
758 <param name="fileName">The name of the file.</param>
760 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.MakeRelative(System.String,System.String)">
761 <summary>Returns a path for the second file that is relative to the first.</summary>
762 <returns>The relative path of the second file.</returns>
763 <param name="filename">The base path.</param>
764 <param name="filename2">The relative path.</param>
766 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.MakeRelativeIfRooted(System.String,Microsoft.VisualStudio.Shell.Url)">
767 <summary>Returns a relative path if the specified file path is absolute and if it is in the same folder as the URL or in a child folder of the URL.</summary>
768 <returns>The relative path to the file.</returns>
769 <param name="fileName">The path to convert.</param>
770 <param name="url">The base URL.</param>
772 <member name="M:Microsoft.VisualStudio.Shell.PackageUtilities.SetStringValueFromConvertedEnum``1(``0,System.Globalization.CultureInfo)">
773 <summary>Returns a string from an enumeration value.</summary>
774 <returns>A string value derived from the enumeration.</returns>
775 <param name="enumValue">The enumeration value.</param>
776 <param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> of the string.</param>
777 <typeparam name="T"></typeparam>
779 <member name="T:Microsoft.VisualStudio.Shell.PropertyPageTypeConverterAttribute">
780 <summary>The class representing the attribute describing how to convert property values on property pages in a package. Use this attribute rather than <see cref="T:System.ComponentModel.TypeConverterAttribute" />.</summary>
782 <member name="M:Microsoft.VisualStudio.Shell.PropertyPageTypeConverterAttribute.#ctor(System.Type)">
783 <summary>Creates a new instance of the class for the specified type.</summary>
784 <param name="t">The type to convert.</param>
786 <member name="P:Microsoft.VisualStudio.Shell.PropertyPageTypeConverterAttribute.ConverterType">
787 <summary>The type that is to be converted.</summary>
789 <see cref="T:System.Type" />.</returns>
791 <member name="T:Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute">
792 <summary>This attribute declares that the VSPackage provides an editor factory.</summary>
794 <member name="M:Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute.#ctor(System.Type,System.Int16)">
795 <summary>This constructor creates a new <see cref="T:Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute" /> object.</summary>
796 <param name="factoryType">The object type that implements <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsEditorFactory" />.</param>
797 <param name="nameResourceID">The resource ID in the unmanaged resource file that contains the localized name of the editor factory.</param>
799 <member name="P:Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute.FactoryType">
800 <summary>Gets the editor factory type.</summary>
801 <returns>The editor factory type.</returns>
803 <member name="P:Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute.NameResourceID">
804 <summary>Gets resource ID.</summary>
805 <returns>Returns the editor factory esource ID specified in the resource file.</returns>
807 <member name="M:Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
808 <summary>Called to register this attribute with the given context.</summary>
809 <param name="context">
810 <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" />. Contains the location where the registration information should be placed, and also contains information about the editor type being registered, and path information.</param>
812 <member name="P:Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute.TrustLevel">
813 <summary>Gets or sets the trust level for the editor.</summary>
815 <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VSEDITORTRUSTLEVEL" />.</returns>
817 <member name="M:Microsoft.VisualStudio.Shell.ProvideEditorFactoryAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
818 <summary>Called to un-register this attribute with the given context.</summary>
819 <param name="context">
820 <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" />. Contains the location where the registration information should be placed, and also contains information about the editor type being registered, and path information.</param>
822 <member name="T:Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute">
823 <summary>Provides a key binding table GUID. By putting this attribute on your <see cref="T:Microsoft.VisualStudio.Shell.Package" />-derived class or class that implements <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsPackage" /> you will declare that it has the given key binding (KEYBINDINGS_SECTION – KEYBINDINGS_END) table in its Command Table Configuration (.Ctc) Files.</summary>
825 <member name="M:Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute.#ctor(System.String,System.Int16)">
826 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute" /> for the specified table and name resource ID.</summary>
827 <param name="tableGuid">The GUID of the key binding table in the Command Table Configuration (.Ctc) Files.</param>
828 <param name="nameResourceID">The resource ID in the unmanaged resource file that contains the localized name of the key binding table. </param>
830 <member name="P:Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute.AllowNavKeyBinding">
831 <summary>Gets or sets whether the user is allowed to bind new commands to navigation keys.</summary>
832 <returns>true if the user is allowed to bind new commands to navigation keys, otherwise false.</returns>
834 <member name="P:Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute.NameResourceID">
835 <summary>Gets the name resource ID.</summary>
836 <returns>The name resource ID</returns>
838 <member name="M:Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
839 <summary>Called to register this attribute with the given context.</summary>
840 <param name="context">A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> 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.</param>
842 <member name="P:Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute.TableGuid">
843 <summary>Gets the GUID of the key binding table.</summary>
844 <returns>The GUID of the key binding table.</returns>
846 <member name="M:Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
847 <summary>Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages.</summary>
848 <param name="context">A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> 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.</param>
850 <member name="T:Microsoft.VisualStudio.Shell.ProvideLanguageEditorOptionPageAttribute">
851 <summary>Informs Visual Studio about a language service property page.</summary>
853 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageEditorOptionPageAttribute.#ctor(System.Type,System.String,System.String,System.String,System.String)">
854 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.ProvideLanguageEditorOptionPageAttribute" /> for the specified page.</summary>
855 <param name="pageType">The type of the option page.</param>
856 <param name="languageName">The language name.</param>
857 <param name="category">The option page category.</param>
858 <param name="pageName">The caption of the option page.</param>
859 <param name="pageNameResourceId">The resource ID of the page.</param>
861 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageEditorOptionPageAttribute.LanguageName">
862 <summary>Gets the name of the language.</summary>
863 <returns>The name of the language. This is the same string that was passed to the class constructor.</returns>
865 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageEditorOptionPageAttribute.PageGuid">
866 <summary>Gets the GUID of the option page.</summary>
867 <returns>The GUID of the option page.</returns>
869 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageEditorOptionPageAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
870 <summary>Creates all the registry keys and entries as specified by the class constructor.</summary>
871 <param name="context">[in] A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> object used to manage registry keys.</param>
873 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageEditorOptionPageAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
874 <summary>Removes all of the registry keys and entries.</summary>
875 <param name="context">[in] A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> object used to manage registry keys.</param>
877 <member name="T:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute">
878 <summary>Associates a file extension with a particular language service.</summary>
880 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute.#ctor(System.String,System.String)">
881 <summary>Initializes a new instance of the <see cref="T:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute" /> attribute, using the specified language service GUID.</summary>
882 <param name="languageServiceGuid">[in] A string containing the GUID of the language service.</param>
883 <param name="extension">[in] A string containing the file extension to associate with the language service.</param>
885 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute.#ctor(System.Type,System.String)">
886 <summary>Initializes a new instance of the <see cref="T:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute" /> attribute, using the type of your language service class.</summary>
887 <param name="languageService">[in] The type of the language service class.</param>
888 <param name="extension">[in] A string containing the file extension to associate with the language service.</param>
890 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute.Extension">
891 <summary>Returns the associated file extension.</summary>
892 <returns>Returns the string containing the file extension that was passed to the constructor of the <see cref="T:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute" /> class.</returns>
894 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute.LanguageService">
895 <summary>Returns the language GUID.</summary>
896 <returns>Returns a <see cref="T:System.Guid" /> object containing the GUID of the language service that was passed to the <see cref="T:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute" /> class constructor.</returns>
898 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
899 <summary>Puts the file extension and language service GUID into the registry.</summary>
900 <param name="context">[in] A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> object used to create registry keys and to log progress.</param>
902 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageExtensionAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
903 <summary>Removes the file extension and language service GUID from the registry.</summary>
904 <param name="context">[in] A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> object used to remove registry keys and to log progress.</param>
906 <member name="T:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute">
907 <summary>Informs Visual Studio that a VSPackage provides a language service. Used with the managed package framework (MPF).</summary>
909 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.#ctor(System.Object,System.String,System.Int32)">
910 <summary>Initializes a new instance of the Shell.ProvideLanguageServiceAttribute class.</summary>
911 <param name="languageService">[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.</param>
912 <param name="strLanguageName">[in] The name of the language. This name is used in the registry for registry key and entry names.</param>
913 <param name="languageResourceID">[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.</param>
915 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.AutoOutlining">
916 <summary>Determines if the language service supports automatic outlining.</summary>
917 <returns>Returns true if the language service supports automatic outlining; otherwise, returns false.</returns>
919 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.CodeSense">
920 <summary>Determines if the language service supports IntelliSense operations.</summary>
921 <returns>Returns true if the language service supports IntelliSense operations; otherwise, returns false.</returns>
923 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.CodeSenseDelay">
924 <summary>Determines the amount of time before a parse operation is started to support an IntelliSense operation.</summary>
925 <returns>Returns the number of milliseconds delay before a parse is started.</returns>
927 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.DebuggerLanguageExpressionEvaluator">
928 <summary>Determines the expression evaluator that is used for evaluating expressions.</summary>
929 <returns>Returns a string containing the GUID of an expression evaluator; otherwise, returns a null value.</returns>
931 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.DefaultToInsertSpaces">
932 <summary>Determines the default setting for the Insert spaces option in the Options dialog box for a language service.</summary>
933 <returns>Returns true if the language service initially uses spaces for formatting; otherwise, returns false to indicate the language service uses tabs.</returns>
935 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.DefaultToNonHotURLs">
936 <summary>Determines the initial setting of the Enable single-click URL navigation option in the Options dialog box.</summary>
937 <returns>Returns true if the Enable single-click URL navigation should be turned off; otherwise, returns false, the option is initially turned on.</returns>
939 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.EnableAdvancedMembersOption">
940 <summary>Determines whether the Hide Advanced Members option is enabled in the Options dialog box.</summary>
941 <returns>Returns true if the Hide Advanced Members option is enabled; otherwise, returns false. </returns>
943 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.EnableAsyncCompletion">
944 <summary>Determines whether the language supports background parsing.</summary>
945 <returns>Returns true if background parsing is allowed; otherwise, returns false.</returns>
947 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.EnableCommenting">
948 <summary>Determines whether the language service can comment and uncomment source code using a single command.</summary>
949 <returns>Returns true if commenting is supported; otherwise, returns false.</returns>
951 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.EnableFormatSelection">
952 <summary>Determines if the language service supports automatic formatting of the source code.</summary>
953 <returns>Returns true if formatting is supported; otherwise, returns false.</returns>
955 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.EnableLineNumbers">
956 <summary>Determines if the Line numbers option can be selected in the Options dialog box.</summary>
957 <returns>Returns true if the Line numbers option is enabled for use; otherwise, returns false.</returns>
959 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.HideAdvancedMembersByDefault">
960 <summary>Determines the initial state of the Hide Advanced Members option in the Options dialog box.</summary>
961 <returns>Returns true if the Hide Advanced Members is initially selected; otherwise, returns false.</returns>
963 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.LanguageName">
964 <summary>Returns the name of the language.</summary>
965 <returns>Returns a string containing the name of the language. This is the same string that was passed to the class constructor.</returns>
967 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.LanguageResourceID">
968 <summary>Returns the resource ID used to obtain the localized version of the language name.</summary>
969 <returns>Returns a number representing the resource ID. This is the same value that was passed to the class constructor.</returns>
971 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.LanguageServiceSid">
972 <summary>Returns the GUID of the language service.</summary>
973 <returns>Returns the GUID of the language service. This is the value that was derived from the object passed to the class constructor.</returns>
975 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.MatchBraces">
976 <summary>Determines if the language service supports matching language pairs.</summary>
977 <returns>Returns true if matching language pairs is supported; otherwise, returns false.</returns>
979 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.MatchBracesAtCaret">
980 <summary>Determines if a language service supports matching language pairs while typing.</summary>
981 <returns>Returns true if language pairs can be matched while typing; otherwise, returns false.</returns>
983 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.MaxErrorMessages">
984 <summary>Determines the maximum number of errors message that a language service can report for a parsing operation.</summary>
985 <returns>Returns a number indicating the maximum number of errors that can be reported.</returns>
987 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.QuickInfo">
988 <summary>Determines if the language service supports the IntelliSense Quick Info.</summary>
989 <returns>Returns true if the IntelliSense Quick Info is supported; otherwise, returns false.</returns>
991 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
992 <summary>Creates all of the registry keys and entries as specified by the class constructor.</summary>
993 <param name="context">[in] A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> object used to manage registry keys.</param>
995 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.RequestStockColors">
996 <summary>Determines if the language service is using the built-in colorable items as supplied by Visual Studio.</summary>
997 <returns>Returns true if the language service uses the built-in colorable items; otherwise, returns false, indicating the language service is supplying custom colorable items.</returns>
999 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.ShowCompletion">
1000 <summary>Determines if the Statement completion options are enabled in the Options dialog box.</summary>
1001 <returns>Returns true if the Statement completion options are enabled; otherwise, returns false.</returns>
1003 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.ShowDropDownOptions">
1004 <summary>Determines if the Navigation bar option is enabled in the Options dialog box.</summary>
1005 <returns>Returns true if the Navigation bar option is to be enabled; otherwise, returns false.</returns>
1007 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.ShowHotURLs">
1008 <summary>Determines if URLs are displayed in such a way as to show they can be clicked. This option is not used.</summary>
1009 <returns>Returns true if URLs are to be displayed "hot" or clickable; otherwise, returns false.</returns>
1011 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.ShowMatchingBrace">
1012 <summary>Determines if the matching language pair is shown in the status bar.</summary>
1013 <returns>Returns true if the matching language pair is shown in the status bar; otherwise, returns false.</returns>
1015 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.ShowSmartIndent">
1016 <summary>Determines if the Smart Indenting option is enabled in the Options dialog box.</summary>
1017 <returns>Returns true if the Smart Indenting option is enabled; otherwise, returns false.</returns>
1019 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.SingleCodeWindowOnly">
1020 <summary>Determines if the Window -> New Window command is disabled for a language service.</summary>
1021 <returns>Returns true if the Window -> New Window command is disabled; otherwise, returns false.</returns>
1023 <member name="P:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.SupportCopyPasteOfHTML">
1024 <summary>Determines if the language service supports the clipboard format HTML for copy and paste operations.</summary>
1025 <returns>Returns true if the HTML clipboard format is supported, otherwise, returns false.</returns>
1027 <member name="M:Microsoft.VisualStudio.Shell.ProvideLanguageServiceAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1028 <summary>Removes all of the registry keys and entries as specified by the class constructor.</summary>
1029 <param name="context">[in] A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> object used to manage registry keys.</param>
1031 <member name="T:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute">
1032 <summary>This attribute provides a package load key for your package.</summary>
1034 <member name="M:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.#ctor(System.String,System.String,System.String,System.String,System.Int16)">
1035 <summary>Creates a new <see cref="T:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute" />.</summary>
1036 <param name="minimumEdition">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).</param>
1037 <param name="productVersion">The version of the product that this VSPackage implements.</param>
1038 <param name="productName">Name of the product that this VSPackage delivers. Products comprised of multiple VSPackages each need their own PLK.</param>
1039 <param name="companyName">VSIP Partner/creator of the VSPackage. Must exactly match the name you provided to Microsoft when you registered for a PLK. <paramref name="companyName" /> is case-sensitive.</param>
1040 <param name="resourceId">Resource ID for VSPackage load key.</param>
1041 <exception cref="T:System.ArgumentNullException">
1042 <paramref name="minimumEdition, productVersion, productName " />or<paramref name=" companyName " />are null.</exception>
1044 <member name="P:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.CompanyName">
1045 <summary>Returns a string containing the CompanyName.</summary>
1046 <returns>The name of your company.</returns>
1048 <member name="P:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.MinimumEdition">
1049 <summary>The MinimumEdition property returns a string containing the minimum edition of Visual Studio needed to load your VSPackage.</summary>
1050 <returns>The minimum edition of Visual Studio needed to load your VSPackage.</returns>
1052 <member name="P:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.ProductName">
1053 <summary>The ProductName property returns a string containing the name of your VSPackage.</summary>
1054 <returns>The name of your VSPackage.</returns>
1056 <member name="P:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.ProductVersion">
1057 <summary>The ProductVersion attribute returns a string containing the version number of your VSPackage.</summary>
1058 <returns>The version number of your VSPackage.</returns>
1060 <member name="M:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1061 <summary>Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages.</summary>
1062 <param name="context">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.</param>
1064 <member name="M:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.RegKeyName(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1065 <summary>Returns the registry key name for this package's load key information.</summary>
1066 <returns>The Registry Key name for the load key information of the VSPackage.</returns>
1067 <param name="context">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.</param>
1069 <member name="P:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.ResourceId">
1070 <summary>Gets resource ID for the Package Load Key.</summary>
1071 <returns>The resource ID for the Package Load Key.</returns>
1073 <member name="M:Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1074 <summary>Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages.</summary>
1075 <param name="context">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.</param>
1077 <member name="P:Microsoft.VisualStudio.Shell.ProvideOptionPageAttribute.ProfileMigrationType"></member>
1078 <member name="T:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute">
1079 <summary>Registers a VSPackage as providing one or more dialog pages in the Customize Toolbox dialog page of the Visual Studio IDE.</summary>
1081 <member name="M:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute.#ctor(System.Type,System.Int16)">
1082 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute" />, using the type of the class implementing the Customize Toolbox dialog page, and a resource ID.</summary>
1083 <param name="pageType">[in] The <see cref="T:System.Type" /> of the class implementing the Customize Toolbox dialog page. This type must derive from the <see cref="T:Microsoft.VisualStudio.Shell.DialogPage" /> class.</param>
1084 <param name="nameResourceID">[in] The native resource ID in a VSPackage's satellite dll containing the name for the tab hosting this Customize Toolbox dialog page.</param>
1086 <member name="M:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute.#ctor(System.Type,System.Int16,System.Int16)">
1087 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute" />, using the type of the class implementing the Customize Toolbox dialog page, a resource ID, and a page order.</summary>
1088 <param name="pageType">[in] The type of the class implementing the Customize Toolbox dialog page. This type must derive from the <see cref="T:Microsoft.VisualStudio.Shell.DialogPage" /> class.</param>
1089 <param name="nameResourceID">[in] The native resource ID in a VSPackage's satellite dll containing the name for the tab of hosting this Customize Toolbox dialog page.</param>
1090 <param name="pageOrder">[in] The Customize Toolbox dialog page placement in the pages of the Visual Studio Customize Toolbox Dialog. A value of 0 indicates that no order is requested. </param>
1092 <member name="M:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute.#ctor(System.Type,System.Int16,System.Int16,System.String)">
1093 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute" />, using the <see cref="T:System.Type" /> of the class implementing the Customize Toolbox dialog page, a resource ID, a page order, and a help string.</summary>
1094 <param name="pageType">[in] The type of the class implementing the Customize Toolbox dialog page. This type must derive from the <see cref="T:Microsoft.VisualStudio.Shell.DialogPage" /> class.</param>
1095 <param name="nameResourceID">[in] The native resource ID in a VSPackage's satellite dll containing the name for the tab of hosting this Customize Toolbox dialog page.</param>
1096 <param name="pageOrder">[in] The Customize Toolbox dialog page placement in the pages of the Visual Studio Customize Toolbox Dialog box. A value of zero indicates that no order is requested. </param>
1097 <param name="helpKeyword">[in] A help keyword used by the help system to find the correct help topic information.</param>
1099 <member name="P:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute.HelpKeyword">
1100 <summary>Gets a help keyword associated with the Customize Toolbox dialog page.</summary>
1101 <returns>The help keyword used to obtain information about the Customize Toolbox dialog page.</returns>
1103 <member name="P:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute.PageOrder">
1104 <summary>Gets the page order requested for the Customize Toolbox dialog page</summary>
1105 <returns>The page order requested for the Customize Toolbox dialog page.</returns>
1107 <member name="M:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1108 <summary>Registers the toolbox page.</summary>
1109 <param name="context">A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> describing the location and values of the registry key.</param>
1111 <member name="P:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute.TypeId">
1112 <summary>Gets the instance of the class implementing the Customize Toolbox dialog page.</summary>
1113 <returns>The current instance of the class implementing the Customize Toolbox dialog page.</returns>
1115 <member name="M:Microsoft.VisualStudio.Shell.ProvideToolboxPageAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1116 <summary>Removes the toolbox page registry key.</summary>
1117 <param name="context">A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> describing the location and values of the registry key.</param>
1119 <member name="T:Microsoft.VisualStudio.Shell.ProvideViewAttribute">
1120 <summary>This attribute declares that an editor factory class offers a particular logical view.</summary>
1122 <member name="M:Microsoft.VisualStudio.Shell.ProvideViewAttribute.#ctor(Microsoft.VisualStudio.Shell.LogicalView,System.String)">
1123 <summary>Creates a new attribute.</summary>
1124 <param name="logicalView">An enumeration of the kinds of logical views available.</param>
1125 <param name="physicalView">The GUID of the physical view. This can be null to indicate the default physical view.</param>
1127 <member name="P:Microsoft.VisualStudio.Shell.ProvideViewAttribute.LogicalView">
1128 <summary>Gets the logical view in this attribute.</summary>
1130 <see cref="T:Microsoft.VisualStudio.Shell.LogicalView" />.</returns>
1132 <member name="P:Microsoft.VisualStudio.Shell.ProvideViewAttribute.PhysicalView">
1133 <summary>Returns the physical view that is mapped to the logical view.</summary>
1135 <see cref="P:Microsoft.VisualStudio.Shell.ProvideViewAttribute.PhysicalView" />.</returns>
1137 <member name="T:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute">
1138 <summary>See <see cref="T:Microsoft.VisualStudio.Shell.ProvideEditorExtensionAttribute" />. Registers a file extension with a given editor factory. This class cannot be inherited.</summary>
1140 <member name="M:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.#ctor(System.Object,System.String,System.Int32)">
1141 <summary>Initializes a new <see cref="T:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute" /> for the supplied factory type and extension.</summary>
1142 <param name="factoryType">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.</param>
1143 <param name="extension">The file extension to associate with the editor factory. This extension should include the prefix “.”.</param>
1144 <param name="priority">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.</param>
1145 <exception cref="T:System.ArgumentNullException">This method throws an <see cref="T:System.ArgumentNullException" /> if:Factory GUID value passed in <paramref name="factoryType" /> is null.<paramref name="extension" /> is null.</exception>
1146 <exception cref="T:System.ArgumentException">This method throws an <see cref="T:System.ArgumentException" /> if:The factory GUID string cannot be converted to a GUID object. Extension does not begin with a “.”.</exception>
1148 <member name="P:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.EditorFactoryNotify">
1149 <summary>Gets or sets whether or not to create the EditorFactoryNotify registry key on registration.</summary>
1150 <returns>true if the EditorFactoryNotify registry key should be created, otherwise false.</returns>
1152 <member name="P:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.Extension">
1153 <summary>Gets the file extension of the file.</summary>
1154 <returns>The file extension for this editor.</returns>
1156 <member name="P:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.Factory">
1157 <summary>Gets the editor factory GUID.</summary>
1158 <returns>The GUID of the editor factory.</returns>
1160 <member name="P:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.NameResourceID">
1161 <summary>Gets or sets the name resource ID.</summary>
1162 <returns>The name resource ID.</returns>
1164 <member name="P:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.Priority">
1165 <summary>Gets the priority of this extension registration.</summary>
1166 <returns>The priority for this editor for its file extension.</returns>
1168 <member name="P:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.ProjectGuid">
1169 <summary>Gets or sets the project GUID.</summary>
1170 <returns>The project GUID.</returns>
1172 <member name="M:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1173 <summary>Registers the editor extension.</summary>
1174 <param name="context">A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> that describes the location and values of a registry key.</param>
1175 <exception cref="T:System.ArgumentNullException">This method throws an <see cref="T:System.ArgumentNullException" /> if <paramref name="context" /> is null.</exception>
1177 <member name="P:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.TemplateDir">
1178 <summary>Gets or sets the template directory.</summary>
1179 <returns>The template directory.</returns>
1181 <member name="M:Microsoft.VisualStudio.Shell.RegisterEditorExtensionAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1182 <summary>Removes the editor extension registry key.</summary>
1183 <param name="context">A <see cref="T:Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext" /> that describes the location and values of a registry key.</param>
1184 <exception cref="T:System.ArgumentNullException">This method throws an <see cref="T:System.ArgumentNullException" /> if the <paramref name="context" /> argument is null.</exception>
1186 <member name="T:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute">
1187 <summary>Registers a Package load key with the VSPackage. This class cannot be inherited.</summary>
1189 <member name="M:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.#ctor(System.String,System.String,System.String,System.String,System.Int16)">
1190 <summary>Creates a new <see cref="T:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute" />.</summary>
1191 <param name="minimumEdition">The minimum edition of Visual Studio .NET needed to load the VSPackage.</param>
1192 <param name="productVersion">The version number of the VSPackage.</param>
1193 <param name="productName">The name of the VSPackage.</param>
1194 <param name="companyName">The name of your company.</param>
1195 <param name="resourceId">The resource ID for the VSPackage load key.</param>
1196 <exception cref="T:System.ArgumentNullException">
1197 <paramref name="minimumEdition, productVersion, productName " />or<paramref name=" companyName " />are null.</exception>
1199 <member name="P:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.CompanyName">
1200 <summary>The CompanyName property returns a string containing the name of your company.</summary>
1201 <returns>The name of your company.</returns>
1203 <member name="P:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.MinimumEdition">
1204 <summary>The MinimumEdition property returns a string containing the minimum edition of Visual Studio needed to load your VSPackage.</summary>
1205 <returns>The minimum edition of Visual Studio needed to load your VSPackage.</returns>
1207 <member name="P:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.ProductName">
1208 <summary>The ProductName property returns a string containing the name of your VSPackage.</summary>
1209 <returns>The name of your VSPackage.</returns>
1211 <member name="P:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.ProductVersion">
1212 <summary>The ProductVersion attribute returns a string containing the version number of your VSPackage.</summary>
1213 <returns>The version number of your VSPackage.</returns>
1215 <member name="M:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.Register(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1216 <summary>Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages.</summary>
1217 <param name="context">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.</param>
1219 <member name="M:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.RegKeyName(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1220 <summary>Retrieves the registry key name for the load key information of the VSPackage.</summary>
1221 <returns>The Registry Key name for the load key information of the VSPackage.</returns>
1222 <param name="context">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.</param>
1224 <member name="P:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.ResourceId">
1225 <summary>Gets resource ID for the Package Load Key.</summary>
1226 <returns>The resource ID for the Package Load Key.</returns>
1228 <member name="M:Microsoft.VisualStudio.Shell.RegisterLoadKeyAttribute.Unregister(Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext)">
1229 <summary>Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages.</summary>
1230 <param name="context">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.</param>
1232 <member name="T:Microsoft.VisualStudio.Shell.RunningDocumentInfo">
1233 <summary>Represents information about a document in the <see cref="T:Microsoft.VisualStudio.Shell.RunningDocumentTable" />. It includes all the information returned by <see cref="M:Microsoft.VisualStudio.Shell.Interop.IVsRunningDocumentTable.GetDocumentInfo(System.UInt32,System.UInt32@,System.UInt32@,System.UInt32@,System.String@,Microsoft.VisualStudio.Shell.Interop.IVsHierarchy@,System.UInt32@,System.IntPtr@)" />.</summary>
1235 <member name="F:Microsoft.VisualStudio.Shell.RunningDocumentInfo.DocData">
1236 <summary>The document object in the Running Document Table (RDT).</summary>
1238 <member name="F:Microsoft.VisualStudio.Shell.RunningDocumentInfo.EditLocks">
1239 <summary>The number of edit locks held on the document.</summary>
1241 <member name="F:Microsoft.VisualStudio.Shell.RunningDocumentInfo.Flags">
1242 <summary>The <see cref="T:Microsoft.VisualStudio.Shell.Interop._VSRDTFLAGS" /> set on the document.</summary>
1244 <member name="F:Microsoft.VisualStudio.Shell.RunningDocumentInfo.Hierarchy">
1245 <summary>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsHierarchy" /> interface of the hierarchy node that owns the document.</summary>
1247 <member name="F:Microsoft.VisualStudio.Shell.RunningDocumentInfo.ItemId">
1248 <summary>The item ID of the node that holds the document.</summary>
1250 <member name="F:Microsoft.VisualStudio.Shell.RunningDocumentInfo.Moniker">
1251 <summary>The absolute path of the document.</summary>
1253 <member name="F:Microsoft.VisualStudio.Shell.RunningDocumentInfo.ReadLocks">
1254 <summary>The number of read locks held on the document.</summary>
1256 <member name="T:Microsoft.VisualStudio.Shell.Task">
1257 <summary>An implementation of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsTaskItem" />, used to modify the appearance and functionality of a task in the task list.</summary>
1259 <member name="M:Microsoft.VisualStudio.Shell.Task.#ctor">
1260 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.Task" />.</summary>
1262 <member name="M:Microsoft.VisualStudio.Shell.Task.#ctor(System.Exception)">
1263 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.Task" /> for the supplied exception.</summary>
1264 <param name="error">The <see cref="T:System.Exception" /> used to create the task.</param>
1266 <member name="P:Microsoft.VisualStudio.Shell.Task.CanDelete">
1267 <summary>Gets or sets whether or not the task can be deleted.</summary>
1268 <returns>true if the task can be deleted, otherwise false.</returns>
1270 <member name="P:Microsoft.VisualStudio.Shell.Task.Category">
1271 <summary>Gets or sets the task's category.</summary>
1273 <see cref="T:Microsoft.VisualStudio.Shell.TaskCategory" />.</returns>
1275 <member name="P:Microsoft.VisualStudio.Shell.Task.Checked">
1276 <summary>Gets or sets whether not the task's check box is currently selected or cleared.</summary>
1277 <returns>true if the task is checked, otherwise false.</returns>
1279 <member name="P:Microsoft.VisualStudio.Shell.Task.Column">
1280 <summary>Gets or sets the column number within the file associated with the task.</summary>
1281 <returns>The column number of the task.</returns>
1283 <member name="F:Microsoft.VisualStudio.Shell.Task.contextNameKeyword">
1284 <summary>Represents the keyword for the user context. This field is constant.</summary>
1286 <member name="E:Microsoft.VisualStudio.Shell.Task.Deleted">
1287 <summary>Handles <see cref="M:Microsoft.VisualStudio.Shell.Task.OnDeleted(System.EventArgs)" /> events.</summary>
1289 <member name="P:Microsoft.VisualStudio.Shell.Task.Document">
1290 <summary>Gets or sets the file associated with the task.</summary>
1291 <returns>The name of the file.</returns>
1293 <member name="M:Microsoft.VisualStudio.Shell.Task.GetUserContext(Microsoft.VisualStudio.Shell.Interop.IVsUserContext@)">
1294 <summary>Creates a new user context.</summary>
1295 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1296 <param name="ppctx">[out] The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUserContext" /> that has been created.</param>
1298 <member name="E:Microsoft.VisualStudio.Shell.Task.Help">
1299 <summary>Handles <see cref="M:Microsoft.VisualStudio.Shell.Task.OnHelp(System.EventArgs)" /> events.</summary>
1301 <member name="P:Microsoft.VisualStudio.Shell.Task.HelpKeyword">
1302 <summary>Gets or sets the Help keyword associated with the task.</summary>
1303 <returns>The Help keyword.</returns>
1305 <member name="P:Microsoft.VisualStudio.Shell.Task.ImageIndex">
1306 <summary>Gets or sets the index of the image associated with the task.</summary>
1307 <returns>The index of the image associated with the task.</returns>
1309 <member name="P:Microsoft.VisualStudio.Shell.Task.IsCheckedEditable">
1310 <summary>Gets or sets whether or not it is possible to edit the checked state of the task.</summary>
1311 <returns>true if it is possible to edit the checked state of the task, otherwise false.</returns>
1313 <member name="P:Microsoft.VisualStudio.Shell.Task.IsPriorityEditable">
1314 <summary>Gets or sets whether or not it is possible to edit the priority of a task.</summary>
1315 <returns>true if it is possible to edit the priority of a task, otherwise false.</returns>
1317 <member name="P:Microsoft.VisualStudio.Shell.Task.IsTextEditable">
1318 <summary>Gets or sets whether or not it is possible to edit the description of a task.</summary>
1319 <returns>true if it is possible to edit the description of a task, otherwise false.</returns>
1321 <member name="P:Microsoft.VisualStudio.Shell.Task.Line">
1322 <summary>Gets or sets the line number of the file associated with the task.</summary>
1323 <returns>The line number of the file associated with the task.</returns>
1325 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#CanDelete(System.Int32@)">
1326 <summary>Gets whether or not it is possible to delete the task.</summary>
1328 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1329 <param name="fdelete">[out] Returns true if it is possible to delete the task, otherwise false.</param>
1331 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#Category(Microsoft.VisualStudio.Shell.Interop.VSTASKCATEGORY[])">
1332 <summary>Sets the task category.</summary>
1333 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1334 <param name="cat">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSTASKCATEGORY" /> objects.</param>
1336 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#Column(System.Int32@)">
1337 <summary>Gets the column number of the file associated with the task.</summary>
1338 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code. </returns>
1339 <param name="col">[out] Returns the column number.</param>
1341 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#Document(System.String@)">
1342 <summary>Gets the name of the file associated with the task.</summary>
1343 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1344 <param name="doc">[out] Returns the name of the file.</param>
1346 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#get_Checked(System.Int32@)">
1347 <summary>Determines whether the task item's check box is currently selected or cleared.</summary>
1348 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1349 <param name="f">[out] Returns true if the check box is selected, otherwise false.</param>
1351 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#get_Priority(Microsoft.VisualStudio.Shell.Interop.VSTASKPRIORITY[])">
1352 <summary>Gets the priority of the task.</summary>
1353 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1354 <param name="pri">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSTASKPRIORITY" /> objects.</param>
1356 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#get_Text(System.String@)">
1357 <summary>Gets the description of the task.</summary>
1358 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1359 <param name="text">[out] The description of the task.</param>
1361 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#HasHelp(System.Int32@)">
1362 <summary>Determines whether or not the task has associated help.</summary>
1363 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1364 <param name="fHelp">[out] Returns true if there is help associated with the task, otherwise false.</param>
1366 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#ImageListIndex(System.Int32@)">
1367 <summary>Gets the index of the image associated with the task.</summary>
1368 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1369 <param name="index">[out] The index of the associated image.</param>
1371 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#IsReadOnly(Microsoft.VisualStudio.Shell.Interop.VSTASKFIELD,System.Int32@)">
1372 <summary>Determines whether or not the specified task field is read-only.</summary>
1373 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1374 <param name="field">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSTASKFIELD" />.</param>
1375 <param name="fReadOnly">[out] Returns true if the field is read-only, otherwise false.</param>
1377 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#Line(System.Int32@)">
1378 <summary>Gets the line number of the file associated with the task.</summary>
1379 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1380 <param name="line">[out] Returns the line number of the file.</param>
1382 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#NavigateTo">
1383 <summary>Opens a file associated with a task and moves to the appropriate position in the file. </summary>
1385 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1387 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#NavigateToHelp">
1388 <summary>Opens the Help resource associated with a task.</summary>
1390 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1392 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#OnDeleteTask">
1393 <summary>Raised when a task has been deleted.</summary>
1395 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1397 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#OnFilterTask(System.Int32)">
1398 <summary>Raised when a task has been filtered into or out of a view.</summary>
1400 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1401 <param name="f">If true, the task has become visible, otherwise it has become invisible.</param>
1403 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#put_Checked(System.Int32)">
1404 <summary>Sets whether a task item's check box is selected or cleared.</summary>
1406 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1407 <param name="f">true if the check box is selected, false if it is cleared.</param>
1409 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#put_Priority(Microsoft.VisualStudio.Shell.Interop.VSTASKPRIORITY)">
1410 <summary>Sets the priority level of a task item. </summary>
1412 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1413 <param name="pri">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSTASKPRIORITY" />.</param>
1415 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#put_Text(System.String)">
1416 <summary>Sets the description of the task.</summary>
1418 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1419 <param name="t">The description of the task.</param>
1421 <member name="M:Microsoft.VisualStudio.Shell.Task.Microsoft#VisualStudio#Shell#Interop#IVsTaskItem#SubcategoryIndex(System.Int32@)">
1422 <summary>Gets the index of the task in the subcategory list.</summary>
1424 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1425 <param name="index">[out] Returns the index.</param>
1427 <member name="E:Microsoft.VisualStudio.Shell.Task.Navigate">
1428 <summary>Handles <see cref="M:Microsoft.VisualStudio.Shell.Task.OnNavigate(System.EventArgs)" /> events.</summary>
1430 <member name="M:Microsoft.VisualStudio.Shell.Task.OnDeleted(System.EventArgs)">
1431 <summary>Raised when the task has been deleted.</summary>
1433 <see cref="T:System.EventArgs" />.</param>
1435 <member name="M:Microsoft.VisualStudio.Shell.Task.OnHelp(System.EventArgs)">
1436 <summary>Raised when the user requests Help; for example by right-clicking and selecting Show Error Help.</summary>
1438 <see cref="T:System.EventArgs" />.</param>
1440 <member name="M:Microsoft.VisualStudio.Shell.Task.OnNavigate(System.EventArgs)">
1441 <summary>Raised when the user attempts to navigate to the task's location in the file, for example by double-clicking on the task.</summary>
1443 <see cref="T:System.EventArgs" />.</param>
1445 <member name="M:Microsoft.VisualStudio.Shell.Task.OnRemoved(System.EventArgs)">
1446 <summary>Raised when a task has been removed from the task list.</summary>
1448 <see cref="T:System.EventArgs" />.</param>
1450 <member name="P:Microsoft.VisualStudio.Shell.Task.Priority">
1451 <summary>Gets or sets the priority of a task.</summary>
1453 <see cref="T:Microsoft.VisualStudio.Shell.TaskPriority" />.</returns>
1455 <member name="E:Microsoft.VisualStudio.Shell.Task.Removed">
1456 <summary>Handles <see cref="M:Microsoft.VisualStudio.Shell.Task.OnRemoved(System.EventArgs)" /> events.</summary>
1458 <member name="P:Microsoft.VisualStudio.Shell.Task.SubcategoryIndex">
1459 <summary>Gets or sets the index of the subcategory of the task.</summary>
1460 <returns>The index of the subcategory of a task.</returns>
1462 <member name="P:Microsoft.VisualStudio.Shell.Task.Text">
1463 <summary>Gets or sets the description of a task.</summary>
1464 <returns>The description of a task.</returns>
1466 <member name="T:Microsoft.VisualStudio.Shell.ToolWindowOrientation">
1467 <summary>This enumeration provides a number of possible tool window orientations with respect to a docking window.</summary>
1469 <member name="F:Microsoft.VisualStudio.Shell.ToolWindowOrientation.none">
1470 <summary>No tool window orientation indicated.</summary>
1472 <member name="F:Microsoft.VisualStudio.Shell.ToolWindowOrientation.Top">
1473 <summary>Tool window initially oriented against the top of the docking window.</summary>
1475 <member name="F:Microsoft.VisualStudio.Shell.ToolWindowOrientation.Left">
1476 <summary>Tool window initially oriented to the left of the docking window.</summary>
1478 <member name="F:Microsoft.VisualStudio.Shell.ToolWindowOrientation.Right">
1479 <summary>Tool window initially oriented to the right of the docking window.</summary>
1481 <member name="F:Microsoft.VisualStudio.Shell.ToolWindowOrientation.Bottom">
1482 <summary>Tool window initially oriented against the bottom of the docking window.</summary>
1484 <member name="T:Microsoft.VisualStudio.Shell.ToolWindowPane">
1485 <summary>A default implementation for a tool window. It can be subclassed to implement a customized tool window.</summary>
1487 <member name="M:Microsoft.VisualStudio.Shell.ToolWindowPane.#ctor(System.IServiceProvider)">
1488 <summary>Initializes an instance of this class.</summary>
1489 <param name="provider">The single constructor argument is a service provider that the created window can use to obtain services. This parameter must not be nullbecause the tool window cannot add itself to the shell.</param>
1491 <member name="P:Microsoft.VisualStudio.Shell.ToolWindowPane.BitmapIndex">
1492 <summary>Gets or sets the index of the image in the bitmap strip to use for the window frame icon.</summary>
1493 <returns>The index of the image to use for the window frame icon.</returns>
1495 <member name="P:Microsoft.VisualStudio.Shell.ToolWindowPane.BitmapResourceID">
1496 <summary>Gets or sets the resource ID for the bitmap strip from which to take the window frame icon.</summary>
1497 <returns>The resource ID for the bitmap strip.</returns>
1499 <member name="P:Microsoft.VisualStudio.Shell.ToolWindowPane.Caption">
1500 <summary>Gets or sets the caption for the tool window.</summary>
1501 <returns>The caption of the tool window.</returns>
1503 <member name="P:Microsoft.VisualStudio.Shell.ToolWindowPane.Frame">
1504 <summary>Gets or sets the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" /> that hosts the ToolWindowPane.</summary>
1506 <see cref=":Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" />.</returns>
1508 <member name="M:Microsoft.VisualStudio.Shell.ToolWindowPane.GetIVsWindowPane">
1509 <summary>Gets the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowPane" /> that is associated with the tool window.</summary>
1511 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowPane" />.</returns>
1513 <member name="M:Microsoft.VisualStudio.Shell.ToolWindowPane.OnToolBarAdded">
1514 <summary>Called when a toolbar is added to the tool window.</summary>
1516 <member name="M:Microsoft.VisualStudio.Shell.ToolWindowPane.OnToolWindowCreated">
1517 <summary>This method can be overridden by the derived class to execute any code that must run after the creation of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" />.</summary>
1519 <member name="P:Microsoft.VisualStudio.Shell.ToolWindowPane.Package">
1520 <summary>Gets or sets the package that owns the tool window.</summary>
1522 <see cref="T:Microsoft.VisualStudio.Shell.Package" />.</returns>
1524 <member name="P:Microsoft.VisualStudio.Shell.ToolWindowPane.ToolBar">
1525 <summary>Gets or sets the <see cref="T:System.ComponentModel.Design.CommandID" />.</summary>
1527 <see cref="T:System.ComponentModel.Design.CommandID" /> if the tool window has a toolbar; otherwise, null.</returns>
1529 <member name="P:Microsoft.VisualStudio.Shell.ToolWindowPane.ToolBarLocation">
1530 <summary>Gets or sets the location of the toolbar in the tool window.</summary>
1531 <returns>A value from the <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSTWT_LOCATION" /> enumeration.</returns>
1533 <member name="P:Microsoft.VisualStudio.Shell.ToolWindowPane.ToolClsid">
1534 <summary>Gets or sets the CLSID of a tool that should be used for this tool window.</summary>
1535 <returns>The CLSID of the tool.</returns>
1537 <member name="T:Microsoft.VisualStudio.Shell.VSRegistry">
1538 <summary>Provides utility functions for discovering the registry hive under which Visual Studio is currently running.</summary>
1540 <member name="M:Microsoft.VisualStudio.Shell.VSRegistry.RegistryRoot(Microsoft.VisualStudio.Shell.Interop.__VsLocalRegistryType)">
1541 <summary>Represents the root of the registry hive under which Visual Studio is currently running, in the specified part of the registry.</summary>
1542 <param name="registryType">A <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VsLocalRegistryType" /> enumeration specifying the part of the registry.</param>
1544 <member name="M:Microsoft.VisualStudio.Shell.VSRegistry.RegistryRoot(Microsoft.VisualStudio.Shell.Interop.__VsLocalRegistryType,System.Boolean)">
1545 <summary>Represents the root of the registry hive under which Visual Studio is currently running, in the specified part of the registry.</summary>
1546 <param name="registryType">A <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VsLocalRegistryType" /> enumeration specifying the part of the registry.</param>
1547 <param name="writable">Whether or not the root is writable</param>
1549 <member name="M:Microsoft.VisualStudio.Shell.VSRegistry.RegistryRoot(System.IServiceProvider,Microsoft.VisualStudio.Shell.Interop.__VsLocalRegistryType,System.Boolean)">
1550 <summary>Represents the root of the registry hive under which Visual Studio is currently running, in the specified part of the registry.</summary>
1551 <param name="provider">The current <see cref="T:System.IServiceProvider" />.</param>
1552 <param name="registryType">A <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VsLocalRegistryType" /> enumeration specifying the part of the registry.</param>
1553 <param name="writable">Whether or not the root is writable.</param>
1555 <member name="T:Microsoft.VisualStudio.Shell.VsShellUtilities">
1556 <summary>Provides static helper methods to use with the Visual Studio shell.</summary>
1558 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.EmptyTaskList(System.IServiceProvider)">
1559 <summary>Empties the task list.</summary>
1560 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1561 <param name="serviceProvider">
1562 <see cref="T:System.IServiceProvider" />.</param>
1564 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetDebugMode(System.IServiceProvider)">
1565 <summary>Gets the current debug mode of the shell, for example, design mode, running mode, or break mode.</summary>
1566 <returns>One of the <see cref="T:Microsoft.VisualStudio.Shell.Interop.DBGMODE" /> values.</returns>
1567 <param name="serviceProvider">
1568 <see cref="T:System.IServiceProvider" />.</param>
1570 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetHierarchy(System.IServiceProvider,System.Guid)">
1571 <summary>Gets the hierarchy node that is specified by the project GUID.</summary>
1572 <returns>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsHierarchy" /> interface of the project.</returns>
1574 <see cref="T:System.IServiceProvider" />.</param>
1575 <param name="projectGuid">The GUID of the project.</param>
1577 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetMiscellaneousProject(System.IServiceProvider)">
1578 <summary>Gets the miscellaneous project from the current solution.</summary>
1579 <returns>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject3" /> interface of the miscellaneous project.</returns>
1580 <param name="provider">
1581 <see cref="T:System.IServiceProvider" />.</param>
1583 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetMiscellaneousProject(System.IServiceProvider,System.Boolean)">
1584 <summary>Returns the miscellaneous project in a solution.</summary>
1585 <returns>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject3" /> interface of the miscellaneous project.</returns>
1586 <param name="provider">
1587 <see cref="T:System.IServiceProvider" /> object used to retrieve the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsSolution" /> object.</param>
1588 <param name="create">true if the project should be created; otherwise, false.</param>
1590 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetOutputWindowPane(System.IServiceProvider,System.Guid)">
1591 <summary>Gets the output window pane that is specified by the GUID.</summary>
1592 <returns>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsOutputWindowPane" /> interface that is specified by the GUID.</returns>
1593 <param name="serviceProvider">
1594 <see cref="T:System.IServiceProvider" />.</param>
1595 <param name="guidPane">The GUID of the output window pane.</param>
1597 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetProject(System.IServiceProvider,System.String)">
1598 <summary>Returns a project for the specified document.</summary>
1599 <returns>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsHierarchy" /> interface of the project that contains the document.</returns>
1600 <param name="site">The <see cref="T:System.IServiceProvider" /> object that is used to retrieve the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsSolution" /> object.</param>
1601 <param name="moniker">The unique identifier of the document in the project system.</param>
1603 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetRDTDocumentInfo(System.IServiceProvider,System.String,Microsoft.VisualStudio.Shell.Interop.IVsHierarchy@,System.UInt32@,Microsoft.VisualStudio.Shell.Interop.IVsPersistDocData@,System.UInt32@)">
1604 <summary>Gets an <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsPersistDocData" /> interface and a document cookie from the running document table for the specified document.</summary>
1606 <see cref="T:System.IServiceProvider" />.</param>
1607 <param name="documentName">The moniker of the file.</param>
1608 <param name="hierarchy">[out] The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsHierarchy" /> interface of the project that containa the document.</param>
1609 <param name="itemid">[out] The item ID of the document.</param>
1610 <param name="persistDocData">[out] The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsPersistDocData" /> interface for the document.</param>
1611 <param name="docCookie">[out] The identifier of the document that is held by the running document table.</param>
1613 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetRunningDocumentContents(System.IServiceProvider,System.String)">
1614 <summary>Gets the text of the specified file, if it exists in the running document table.</summary>
1615 <returns>The text of the file.</returns>
1617 <see cref="T:System.IServiceProvider" />.</param>
1618 <param name="path">The absolute path of the file.</param>
1620 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetTaskItems(System.IServiceProvider)">
1621 <summary>Gets a list of tasks.</summary>
1622 <returns>An <see cref="T:System.Collections.IList" /> of type <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsTaskItem2" /> of the task items.</returns>
1623 <param name="serviceProvider">
1624 <see cref="T:System.IServiceProvider" />.</param>
1626 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetTextView(Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame)">
1627 <summary>Gets the text view in the specified window frame.</summary>
1628 <returns>The text view in an <see cref="T:Microsoft.VisualStudio.TextManager.Interop.IVsTextView" /> object, or null if the window frame is a code window that is not implemented as a text view.</returns>
1629 <param name="windowFrame">
1630 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" /> that contains the text view.</param>
1632 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetUIHierarchyWindow(System.IServiceProvider,System.Guid)">
1633 <summary>Gets a window for the given GUID.</summary>
1635 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchyWindow" />.</returns>
1636 <param name="serviceProvider">
1637 <see cref="T:System.IServiceProvider" />.</param>
1638 <param name="guidPersistenceSlot">The GUID of the hierarchy window.</param>
1640 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.GetWindowObject(Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame)">
1641 <summary>Gets the window that exists in the specified window frame.</summary>
1642 <returns>The <see cref="T:EnvDTE.Window" />, if there is an object of that type in the frame; otherwise, null.</returns>
1643 <param name="windowFrame">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" /> interface for the window frame.</param>
1645 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.IsDocumentOpen(System.IServiceProvider,System.String,System.Guid,Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy@,System.UInt32@,Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame@)">
1646 <summary>Determines whether the specified document is open.</summary>
1647 <returns>true if the document is open in the given logical view. If <paramref name="logicalView" /> is Guid.Empty, then this method returns true if any view is open; otherwise, false.</returns>
1648 <param name="provider">
1649 <see cref="T:System.IServiceProvider" />.</param>
1650 <param name="fullPath">The full path to the document.</param>
1651 <param name="logicalView">The GUID of the logical view.</param>
1652 <param name="hierarchy">[out] Returns the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy" /> interface of the project that contains the document.</param>
1653 <param name="itemID">[out] Returns the item ID of the document.</param>
1654 <param name="windowFrame">[out] Returns the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" /> in which the document is open.</param>
1656 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.IsInAutomationFunction(System.IServiceProvider)">
1657 <summary>Determines whether the extensibility object is currently executing an automation operation.</summary>
1658 <returns>true if the extensibility object is executing an automation operation; otherwise, false.</returns>
1659 <param name="serviceProvider">
1660 <see cref="T:System.IServiceProvider" />.</param>
1662 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.IsSolutionBuilding(System.IServiceProvider)">
1663 <summary>Determines whether the build manager is busy.</summary>
1664 <returns>true if the build manager is building or deploying the built application; otherwise, false.</returns>
1665 <param name="serviceProvider">
1666 <see cref="T:System.IServiceProvider" />.</param>
1668 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.IsVisualStudioInDesignMode(System.IServiceProvider)">
1669 <summary>Determines whether Visual Studio is in design mode (as opposed to run mode or debug mode).</summary>
1670 <returns>true if Visual Studio is in design mode; otherwise, false.</returns>
1671 <param name="serviceProvider">
1672 <see cref="T:System.IServiceProvider" />.</param>
1674 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.LaunchDebugger(System.IServiceProvider,Microsoft.VisualStudio.Shell.Interop.VsDebugTargetInfo)">
1675 <summary>Starts the debugger.</summary>
1676 <param name="serviceProvider">
1677 <see cref="T:System.IServiceProvider" />.</param>
1678 <param name="info">A <see cref="T:Microsoft.VisualStudio.Shell.Interop.VsDebugTargetInfo" /> structure.</param>
1680 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.OpenAsMiscellaneousFile(System.IServiceProvider,System.String,System.String,System.Guid,System.String,System.Guid)">
1681 <summary>Opens the specified miscellaneous file in the specified editor.</summary>
1682 <param name="provider">
1683 <see cref="T:System.IServiceProvider" />.</param>
1684 <param name="path">The path of the file.</param>
1685 <param name="caption">The name of the file.</param>
1686 <param name="editor">The GUID of the editor in which to open the file.</param>
1687 <param name="physicalView">The name of the kind of window in which to open the editor.</param>
1688 <param name="logicalView">The logical view of the editor, for example <see cref="F:Microsoft.VisualStudio.VSConstants.LOGVIEWID_TextView" />.</param>
1690 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.OpenDocument(System.IServiceProvider,System.String)">
1691 <summary>Opens the specified document.</summary>
1692 <param name="provider">
1693 <see cref="T:System.IServiceProvider" />.</param>
1694 <param name="path">The path of the document.</param>
1696 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.OpenDocument(System.IServiceProvider,System.String,System.Guid,Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy@,System.UInt32@,Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame@)">
1697 <summary>Opens the specified document in the specified view.</summary>
1698 <param name="provider">
1699 <see cref="T:System.IServiceProvider" />.</param>
1700 <param name="fullPath">The absolute path of the document.</param>
1701 <param name="logicalView">The GUID of the logical view in which to open the document.</param>
1702 <param name="hierarchy">[out] Returns the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy" /> interface of the project that contains the document.</param>
1703 <param name="itemID">[out] The item ID of the document.</param>
1704 <param name="windowFrame">[out] Returns the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" /> interface of the window in which the document is open.</param>
1706 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.OpenDocument(System.IServiceProvider,System.String,System.Guid,Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy@,System.UInt32@,Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame@,Microsoft.VisualStudio.TextManager.Interop.IVsTextView@)">
1707 <summary>Opens the specified document in the specified logical view.</summary>
1708 <param name="provider">
1709 <see cref="T:System.IServiceProvider" />.</param>
1710 <param name="fullPath">The absolute path of the document.</param>
1711 <param name="logicalView">The GUID of the logical view in which to open the document.</param>
1712 <param name="hierarchy">[out] Returns the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy" /> interface of the project that contains the document.</param>
1713 <param name="itemID">[out] The item ID of the document.</param>
1714 <param name="windowFrame">[out] Returns the <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" /> interface of the window in which the document is open.</param>
1715 <param name="view">[out] Returns the <see cref="T:Microsoft.VisualStudio.TextManager.Interop.IVsTextView" /> interface of the primary view of the window.</param>
1717 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.OpenDocumentWithSpecificEditor(System.IServiceProvider,System.String,System.Guid,System.Guid)">
1718 <summary>Opens the specified document by using the specified editor.</summary>
1719 <returns>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" /> interface of the window in which the document is opened.</returns>
1720 <param name="provider">
1721 <see cref="T:System.IServiceProvider" />.</param>
1722 <param name="fullPath">The absolute path of the document.</param>
1723 <param name="editorType">The GUID of the type of editor to use.</param>
1724 <param name="logicalView">The GUID of the logical view in which to open the document.</param>
1726 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.OpenDocumentWithSpecificEditor(System.IServiceProvider,System.String,System.Guid,System.Guid,Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy@,System.UInt32@,Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame@)">
1727 <summary>Opens the specified document by using the specified editor.</summary>
1728 <param name="provider">
1729 <see cref="T:System.IServiceProvider" />.</param>
1730 <param name="fullPath">The absolute path of the document.</param>
1731 <param name="editorType">The GUID of the type of editor to use.</param>
1732 <param name="logicalView">The GUID of the logical view in which to open the document.</param>
1733 <param name="hierarchy">[out] The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy" /> interface of the project that contains the document.</param>
1734 <param name="itemID">[out] The item ID of the document.</param>
1735 <param name="windowFrame">[out] The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame" /> interface of the window in which the document is opened.</param>
1737 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.PromptYesNo(System.String,System.String,Microsoft.VisualStudio.Shell.Interop.OLEMSGICON,Microsoft.VisualStudio.Shell.Interop.IVsUIShell)">
1738 <summary>Displays a message box that contains the specified title and prompts the user to respond (yes or no) to the specified message.</summary>
1739 <returns>true if the operation succeeded; otherwise, false.</returns>
1740 <param name="message">The message to which the user must respond.</param>
1741 <param name="title">The title of the message box.</param>
1742 <param name="icon">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.OLEMSGICON" /> that defines the kind of message.</param>
1743 <param name="uiShell">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUIShell" /> interface of the shell in which to display the message box. </param>
1745 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.RenameDocument(System.IServiceProvider,System.String,System.String)">
1746 <summary>Renames the specified document.</summary>
1748 <see cref="T:System.IServiceProvider" />.</param>
1749 <param name="oldName">The current absolute path of the document.</param>
1750 <param name="newName">The new absolute path of the document.</param>
1752 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.SaveFileIfDirty(Microsoft.VisualStudio.TextManager.Interop.IVsTextView)">
1753 <summary>If the file is dirty, saves it in the specified text view.</summary>
1754 <param name="view">The <see cref="T:Microsoft.VisualStudio.TextManager.Interop.IVsTextView" /> interface of the file to be saved.</param>
1756 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.SaveFileIfDirty(System.IServiceProvider,System.String)">
1757 <summary>Saves the specified file if it is dirty.</summary>
1759 <see cref="T:System.IServiceProvider" />.</param>
1760 <param name="fullPath">The absolute path of the file.</param>
1762 <member name="M:Microsoft.VisualStudio.Shell.VsShellUtilities.ShowMessageBox(System.IServiceProvider,System.String,System.String,Microsoft.VisualStudio.Shell.Interop.OLEMSGICON,Microsoft.VisualStudio.Shell.Interop.OLEMSGBUTTON,Microsoft.VisualStudio.Shell.Interop.OLEMSGDEFBUTTON)">
1763 <summary>Displays a message box with the specified message.</summary>
1764 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code. </returns>
1765 <param name="serviceProvider">
1766 <see cref="T:System.IServiceProvider" />.</param>
1767 <param name="message">The message to display.</param>
1768 <param name="title">The title of the message box.</param>
1769 <param name="icon">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.OLEMSGICON" /> value that specifies the type of message.</param>
1770 <param name="msgButton">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.OLEMSGBUTTON" /> value that specifies the set of buttons to display.</param>
1771 <param name="defaultButton">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.OLEMSGDEFBUTTON" /> value that specifies which button is to be the default button.</param>
1773 <member name="T:Microsoft.VisualStudio.Shell.WindowPane">
1774 <summary>A default implementation of a tool window pane. This class implements <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsWindowPane" />, but the implementer must provide an implementation of an object that returns an <see cref="T:System.Windows.Interop.IWin32Window" />. This class also implements <see cref="T:Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget" />, maps it to <see cref="T:System.ComponentModel.Design.IMenuCommandService" /> and <see cref="T:Microsoft.VisualStudio.OLE.Interop.IObjectWithSite" />, and maps the site to services that can be queried through its protected <see cref="M:Microsoft.VisualStudio.Shell.WindowPane.GetService(System.Type)" /> method.</summary>
1776 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.#ctor(System.IServiceProvider)">
1777 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.WindowPane" /> with the specified service provider.</summary>
1778 <param name="provider">
1779 <see cref="T:System.IServiceProvider" />. Should be null.</param>
1781 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Dispose">
1782 <summary>Disposes the window pane and its resources.</summary>
1784 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Dispose(System.Boolean)">
1785 <summary>Disposes the resources of the window pane.</summary>
1786 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
1788 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.GetService(System.Type)">
1789 <summary>Gets the service of the specified type.</summary>
1790 <returns>The service.</returns>
1791 <param name="serviceType"> The type of the service to get.</param>
1793 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Initialize">
1794 <summary>Initializes services after the window pane has been sited. </summary>
1796 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#OLE#Interop#IOleCommandTarget#Exec(System.Guid@,System.UInt32,System.UInt32,System.IntPtr,System.IntPtr)">
1797 <summary>Executes the specified command.</summary>
1798 <returns>Returns <see cref="F:Microsoft.VisualStudio.OLE.Interop.OleConstants.OLECMDERR_E_NOTSUPPORTED" /> if the project manager is closed or the command is not supported. Otherwise, returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> or an error code if one of the executed commands returned an error code.</returns>
1799 <param name="guidGroup">The GUID of the command group to which the command belongs.</param>
1800 <param name="nCmdId">The ID of the command.</param>
1801 <param name="nCmdExcept">Values taken from the <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT" /> enumeration, which describe how the object should execute the command.</param>
1802 <param name="pIn">Pointer to a VARIANTARG structure that contains input arguments. Can be null.</param>
1803 <param name="vOut">Pointer to a VARIANTARG structure that contains command output. Can be null.</param>
1805 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#OLE#Interop#IOleCommandTarget#QueryStatus(System.Guid@,System.UInt32,Microsoft.VisualStudio.OLE.Interop.OLECMD[],System.IntPtr)">
1806 <summary>Queries the object for the status of one or more commands that are generated by user interface events.</summary>
1807 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1808 <param name="guidGroup">Unique identifier of the command group. All the commands that are passed in the <paramref name="prgCmds" /> array must belong to the group that is specified by <paramref name="guidCmdGroup" />.</param>
1809 <param name="nCmdId">The number of commands in the <paramref name="prgCmds" /> array.</param>
1810 <param name="oleCmd">A caller-allocated array of <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMD" /> structures that indicate the commands for which the caller requires status information. This method fills the <paramref name="cmdf " />member of each structure with values taken from the <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDF" /> enumeration.</param>
1811 <param name="oleText">Pointer to an <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDTEXTF" /> structure to return a name and/or status information of a single command. Can be null to indicate that the caller does not require this information.</param>
1813 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#Shell#Interop#IVsBroadcastMessageEvents#OnBroadcastMessage(System.UInt32,System.IntPtr,System.IntPtr)">
1814 <summary>Raised when a message is broadcast to the window. </summary>
1815 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1816 <param name="msg">The broadcast message.</param>
1817 <param name="wParam">A word-value parameter for the message.</param>
1818 <param name="lParam">A long-integer parameter for the message.</param>
1820 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#Shell#Interop#IVsWindowPane#ClosePane">
1821 <summary>Closes the window pane.</summary>
1822 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1824 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#Shell#Interop#IVsWindowPane#CreatePaneWindow(System.IntPtr,System.Int32,System.Int32,System.Int32,System.Int32,System.IntPtr@)">
1825 <summary>Creates a window pane.</summary>
1827 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />. </returns>
1828 <param name="hwndParent">A pointer to the parent window.</param>
1829 <param name="x">The absolute x ordinate.</param>
1830 <param name="y">The absolute y ordinate.</param>
1831 <param name="cx">The width of the window.</param>
1832 <param name="cy">The height of the window.</param>
1833 <param name="pane"> [out] A pointer to the new window pane.</param>
1835 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#Shell#Interop#IVsWindowPane#GetDefaultSize(Microsoft.VisualStudio.OLE.Interop.SIZE[])">
1836 <summary>Gets the default size of the window pane.</summary>
1837 <returns>When implemented by derived classes, if the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1838 <param name="size">An array of <see cref="T:Microsoft.VisualStudio.OLE.Interop.SIZE" /> structures.</param>
1840 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#Shell#Interop#IVsWindowPane#LoadViewState(Microsoft.VisualStudio.OLE.Interop.IStream)">
1841 <summary>Loads the saved view state.</summary>
1842 <returns>When implemented by derived classes, if the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1843 <param name="pstream">The <see cref="T:Microsoft.VisualStudio.OLE.Interop.IStream" /> from which to load the view state.</param>
1845 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#Shell#Interop#IVsWindowPane#SaveViewState(Microsoft.VisualStudio.OLE.Interop.IStream)">
1846 <summary>Saves the loaded view state.</summary>
1847 <returns>When implemented by derived classes, if the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1848 <param name="pstream">The <see cref="T:Microsoft.VisualStudio.OLE.Interop.IStream" /> to which to save the view state.</param>
1850 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#Shell#Interop#IVsWindowPane#SetSite(Microsoft.VisualStudio.OLE.Interop.IServiceProvider)">
1851 <summary>Initializes this window pane with the specified service provider.</summary>
1853 <see cref="T:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
1855 <see cref="T:System.IServiceProvider" />.</param>
1857 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.Microsoft#VisualStudio#Shell#Interop#IVsWindowPane#TranslateAccelerator(Microsoft.VisualStudio.OLE.Interop.MSG[])">
1858 <summary>Handles the translation of navigation keys.</summary>
1859 <returns>If this method succeeds, it returns <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />; if it fails, it returns <see cref="F:Microsoft.VisualStudio.NativeMethods.E_FAIL" />.</returns>
1860 <param name="msg">An array of <see cref="T:Microsoft.VisualStudio.OLE.Interop.MSG" /> structures that contain the character or character combination to be translated.</param>
1862 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.OnClose">
1863 <summary>Raised when the window is closed.</summary>
1865 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.OnCreate">
1866 <summary>Raised when the window pane is created.</summary>
1868 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.PreProcessMessage(System.Windows.Forms.Message@)">
1869 <summary>Preprocesses the messages from navigation keys.</summary>
1870 <returns>true if it was possible to get a control from the message's handle; otherwise, false.</returns>
1871 <param name="m">The <see cref="T:System.Windows.Forms.Message" />.</param>
1873 <member name="M:Microsoft.VisualStudio.Shell.WindowPane.System#IServiceProvider#GetService(System.Type)">
1874 <summary>Gets the service of the specified type.</summary>
1875 <returns>An object that represents the service.</returns>
1876 <param name="serviceType">The type of the service to get.</param>
1878 <member name="P:Microsoft.VisualStudio.Shell.WindowPane.Window">
1879 <summary>Gets the window that is associated with this window pane.</summary>
1881 <see cref="T:System.Windows.Forms.IWin32Window" />.</returns>
1883 <member name="T:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject">
1884 <summary>A project that is a subtype or flavor of an inner project. All methods by default delegate to the inner project. Non-default behaviors should be handled by the flavored project.</summary>
1886 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.#ctor">
1887 <summary>When overridden in a derived class, initializes an instance of the <see cref="T:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject" /> class.</summary>
1889 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.AdviseHierarchyEvents(Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents)">
1890 <summary>Subscribes to hierarchy events.</summary>
1891 <returns>A unique value, or cookie, that is needed to disable notification of hierarchy events.</returns>
1892 <param name="eventSink">
1893 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents" />.</param>
1895 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Close">
1896 <summary>Closes and cleans up a hierarchy once the environment determines that it is no longer used. </summary>
1898 <member name="E:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.DirectoryAdded">
1899 <summary>Raised after a directory has been added to the project.</summary>
1901 <member name="E:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.DirectoryRemoved">
1902 <summary>Raised after a directory has been removed from the project.</summary>
1904 <member name="E:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.DirectoryRenamed">
1905 <summary>Raised after a directory in the project has been renamed.</summary>
1907 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.ExecCommand(System.UInt32,System.Guid@,System.UInt32,System.UInt32,System.IntPtr,System.IntPtr)">
1908 <summary>Executes a command on a specific item within a UI hierarchy window, or on the hierarchy itself. </summary>
1909 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="S_OK" />. If it fails, it returns an error code.</returns>
1910 <param name="itemid">The identifier of the item affected by the command. For single selection, this value is the actual item ID. For multiple selections, set <paramref name="itemid" /> equal to <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="VSITEMID_SELECTION" />.</param>
1911 <param name="pguidCmdGroup">Unique identifier of the command group. All the commands in <paramref name="nCmdID " />must belong to the group specified by <paramref name="pguidCmdGroup" />.</param>
1912 <param name="nCmdID">The command to be executed. This command must belong to the group specified with <paramref name="pguidCmdGroup" />.</param>
1913 <param name="nCmdexecopt">A member of the <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT" /> enumeration, describing the type of action to perform.</param>
1914 <param name="pvaIn">A pointer to a VARIANTARG structure containing input arguments. Can be null.</param>
1915 <param name="pvaOut">A pointer to a VARIANTARG structure to receive command output. Can be null.</param>
1917 <member name="E:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.FileAdded">
1918 <summary>Raised after a file has been added to the project.</summary>
1920 <member name="E:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.FileRemoved">
1921 <summary>Raised after a file has been removed from the project.</summary>
1923 <member name="E:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.FileRenamed">
1924 <summary>Raised after a file in the project has been renamed.</summary>
1926 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.GetCanonicalName(System.UInt32,System.String@)">
1927 <summary>Gets the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions.</summary>
1928 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="S_OK" />. If it fails, it returns an error code.</returns>
1929 <param name="itemId">The ID of the hierarchy item. </param>
1930 <param name="name">[out] The canonical name of the hierarchy item.</param>
1932 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.GetGuidProperty(System.UInt32,System.Int32)">
1933 <summary>Gets properties whose values are GUIDs.</summary>
1934 <returns>The GUID value of the property.</returns>
1935 <param name="itemId">The item ID of the hierarchy node for which to get the property.</param>
1936 <param name="propId">The ID of the property.</param>
1938 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.GetNestedHierarchy(System.UInt32,System.Guid@,System.IntPtr@,System.UInt32@)">
1939 <summary>Determines whether or not a node is a nested hierarchy.</summary>
1940 <returns>If <paramref name="itemid" /> is not a nested hierarchy node, this method returns <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="E_FAIL" />. If the requested interface is not supported on the hierarchy object, <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="E_NOINTERFACE" /> is returned. The caller would then treat this node as if it had no children. </returns>
1941 <param name="itemId">The item ID of the node.</param>
1942 <param name="guidHierarchyNested">The interface ID of the node.</param>
1943 <param name="hierarchyNested">[out] Returns a pointer to the node, if it is a nested hierarchy node. </param>
1944 <param name="itemIdNested">[out] Returns the item ID of the nested hierarchy node; this will always be <see cref="F:Microsoft.VisualStudio.VSConstants.VSITEMID_ROOT" />.</param>
1946 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.GetProperty(System.UInt32,System.Int32,System.Object@)">
1947 <summary>Gets the value of a property for a given node.</summary>
1948 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1949 <param name="itemId">The item ID of the node.</param>
1950 <param name="propId">The ID of the requested property.</param>
1951 <param name="property">[out] The value of the property.</param>
1953 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.GetSite">
1954 <summary>Gets the service provider from which to access the services.</summary>
1956 <see cref="T:Microsoft.VisualStudio.OLE.Interop.IServiceProvider" />.</returns>
1958 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.InitializeForOuter(System.String,System.String,System.String,System.UInt32,System.Guid@,System.Boolean@)">
1959 <summary>Called by the outer project subtype to have the owned inner project subtype do its initialization work. </summary>
1960 <param name="fileName">The name of the project file.</param>
1961 <param name="location">The path of the project file.</param>
1962 <param name="name">The name of the project.</param>
1963 <param name="flags">Flags from the <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VSCREATEPROJECTFLAGS" /> enumeration.</param>
1964 <param name="guidProject">[ref] The interface ID of the project.</param>
1965 <param name="cancel">[out] Returns true if project creation was canceled.</param>
1967 <member name="F:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.innerOleCommandTarget">
1968 <summary>The <see cref="T:Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget" /> interface of the inner project.</summary>
1970 <member name="F:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.innerVsAggregatableProject">
1971 <summary>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsAggregatableProject" /> of the inner project.</summary>
1973 <member name="F:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.innerVsHierarchy">
1974 <summary>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsHierarchy" /> interface of the inner project.</summary>
1976 <member name="F:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.innerVsUIHierarchy">
1977 <summary>The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy" /> interface of the inner project.</summary>
1979 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#OLE#Interop#IOleCommandTarget#Exec(System.Guid@,System.UInt32,System.UInt32,System.IntPtr,System.IntPtr)">
1980 <summary>Executes a specified command or displays help for a command.</summary>
1981 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1982 <param name="pguidCmdGroup">The ID of the command group to which the command belongs.</param>
1983 <param name="nCmdID">The ID of the command.</param>
1984 <param name="nCmdexecopt">A member of the <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT" /> enumeration, describing the type of action to take.</param>
1985 <param name="pvaIn">A pointer to a VARIANTARG structure containing input arguments. May be null.</param>
1986 <param name="pvaOut">A pointer to a VARIANTARG structure containing command output. May be null.</param>
1988 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#OLE#Interop#IOleCommandTarget#QueryStatus(System.Guid@,System.UInt32,Microsoft.VisualStudio.OLE.Interop.OLECMD[],System.IntPtr)">
1989 <summary>Queries the object for the status of one or more commands.</summary>
1990 <returns>If the method succeeded, <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise an error code.</returns>
1991 <param name="pguidCmdGroup">The GUID of the command group to which the commands belong.</param>
1992 <param name="cCmds">The number of commands in the command array.</param>
1993 <param name="prgCmds">An array of <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMD" /> structures that contain information about the commands.</param>
1994 <param name="pCmdText">Pointer to an <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDTEXT" /> structure in which to return name and/or status information of a single command. Can be null.</param>
1996 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsAggregatableProject#GetAggregateProjectTypeGuids(System.String@)">
1997 <summary>Gets the list of project type GUIDs that make up the aggregate project. This method should be delegated to the innermost project within the system of aggregated project subtypes.</summary>
1998 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
1999 <param name="projectTypeGuids">[out] A semicolon-delimited set of project type GUIDs.</param>
2001 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsAggregatableProject#InitializeForOuter(System.String,System.String,System.String,System.UInt32,System.Guid@,System.IntPtr@,System.Int32@)">
2002 <summary>Called by the outer project subtype to have the inner project subtype do its initialization work. </summary>
2003 <returns>If the method succeeds, <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise an error code.</returns>
2004 <param name="fileName">The project file name of the project to be initialized.</param>
2005 <param name="location">The path of the project file. </param>
2006 <param name="name">The name of the project.</param>
2007 <param name="flags">Flags that describe how a project is to be created or opened. Values are taken from the <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VSCREATEPROJFLAGS" /> enumeration.</param>
2008 <param name="guidProject">[ref] The interface ID of the project. It should be <see cref="F:Microsoft.VisualStudio.NativeMethods.IID_IUnknown" />.</param>
2009 <param name="project">[out] A pointer to the project. </param>
2010 <param name="canceled">[out] true if the project was canceled. </param>
2012 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsAggregatableProject#OnAggregationComplete">
2013 <summary>Called to continue initialization after aggregation is complete.</summary>
2014 <returns>If the method succeeded, <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise an error code.</returns>
2016 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsAggregatableProject#SetAggregateProjectTypeGuids(System.String)">
2017 <summary>Updates the list of GUIDs that are persisted in the project file of the base project. </summary>
2018 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />\. If it fails, it returns an error code.</returns>
2019 <param name="projectTypeGuids">The GUIDs to set.</param>
2021 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsAggregatableProject#SetInnerProject(System.Object)">
2022 <summary>Sets up the inner project as well as the necessary interface pointers.</summary>
2023 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2024 <param name="inner">The IUnknown of the inner project subtype.</param>
2026 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#AdviseHierarchyEvents(Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents,System.UInt32@)">
2027 <summary>Subscribes to hierarchy events.</summary>
2028 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2029 <param name="eventSink">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents" /> to which to register.</param>
2030 <param name="cookie">[out] Returns the unique identifier used to unsubscribe for these events.</param>
2032 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#Close">
2033 <summary>Closes and cleans up a hierarchy once the environment determines that it is no longer used. </summary>
2034 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2036 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#GetCanonicalName(System.UInt32,System.String@)">
2037 <summary>Gets a unique name for an item in the hierarchy. Used for workspace persistence, such as remembering window positions. </summary>
2038 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2039 <param name="itemId">The ID of the hierarchy item.</param>
2040 <param name="name">[out] The canonical name of the item.</param>
2042 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#GetGuidProperty(System.UInt32,System.Int32,System.Guid@)">
2043 <summary>Gets properties whose values are GUIDs. </summary>
2044 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2045 <param name="itemId">The ID of the hierarchy item.</param>
2046 <param name="propId">The ID of the property.</param>
2047 <param name="guid">[out] Returns the GUID value of the property.</param>
2049 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#GetNestedHierarchy(System.UInt32,System.Guid@,System.IntPtr@,System.UInt32@)">
2050 <summary>Determines whether or not a node is a nested hierarchy.</summary>
2051 <returns>If <paramref name="itemid" /> is not a nested hierarchy node, this method returns <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="E_FAIL" />. If the requested interface is not supported on the hierarchy object, <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="E_NOINTERFACE" /> is returned. The caller would then treat this node as if it had no children. </returns>
2052 <param name="itemId">The item ID of the node.</param>
2053 <param name="guidHierarchyNested">The interface ID of the node.</param>
2054 <param name="hierarchyNested">[out] Returns a pointer to the node, if it is a nested hierarchy node. </param>
2055 <param name="itemIdNested">[out] Returns the item ID of the nested hierarchy node; this will always be <see cref="F:Microsoft.VisualStudio.VSConstants.VSITEMID_ROOT" />.</param>
2057 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#GetProperty(System.UInt32,System.Int32,System.Object@)">
2058 <summary>Gets properties of a given node or of the hierarchy. </summary>
2059 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2060 <param name="itemId">The ID of the item.</param>
2061 <param name="propId">The ID of the property.</param>
2062 <param name="property">[out] The value of the property. </param>
2064 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#GetSite(Microsoft.VisualStudio.OLE.Interop.IServiceProvider@)">
2065 <summary>Gets the service provider from which to access the services. </summary>
2066 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2067 <param name="serviceProvider"> <see cref="T:Microsoft.VisualStudio.OLE.Interop.IServiceProvider" />.</param>
2069 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#ParseCanonicalName(System.String,System.UInt32@)">
2070 <summary>Returns the identifier of the hierarchy item, given its canonical name. </summary>
2071 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2072 <param name="name">The canonical name of the item.</param>
2073 <param name="itemId">[out] The ID of the item.</param>
2075 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#QueryClose(System.Int32@)">
2076 <summary>Determines whether the hierarchy can be closed. </summary>
2077 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2078 <param name="canClose">[out] Returns true if the hierarchy can be closed, otherwise false. </param>
2080 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#SetGuidProperty(System.UInt32,System.Int32,System.Guid@)">
2081 <summary>Sets properties whose values are GUIDs. </summary>
2082 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2083 <param name="itemId">The ID of the item.</param>
2084 <param name="propId">The ID of the property to set.</param>
2085 <param name="guid">The GUID value of the property.</param>
2087 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#SetProperty(System.UInt32,System.Int32,System.Object)">
2088 <summary>Sets properties of a specific node or of the hierarchy. </summary>
2089 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2090 <param name="itemId">The ID of the item.</param>
2091 <param name="propId">The ID of the property to set.</param>
2092 <param name="property">The value of the property.</param>
2094 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#SetSite(Microsoft.VisualStudio.OLE.Interop.IServiceProvider)">
2095 <summary>Sets the service provider from which to access the services. </summary>
2096 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2097 <param name="serviceProvider">
2098 <see cref="T:Microsoft.VisualStudio.OLE.Interop.IServiceProvider" />.</param>
2100 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#UnadviseHierarchyEvents(System.UInt32)">
2101 <summary>Disables client notification of hierarchy events.</summary>
2102 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2103 <param name="cookie">The unique identifier that was handed back with <see cref="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.AdviseHierarchyEvents(Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents)" />.</param>
2105 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#Unused0">
2106 <summary>A placeholder for a future method.</summary>
2107 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2109 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#Unused1">
2110 <summary>A placeholder for a future method.</summary>
2111 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2113 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#Unused2">
2114 <summary>A placeholder for a future method.</summary>
2115 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2117 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#Unused3">
2118 <summary>A placeholder for a future method.</summary>
2119 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2121 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsHierarchy#Unused4">
2122 <summary>A placeholder for a future method.</summary>
2123 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2125 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnAfterAddDirectoriesEx(System.Int32,System.Int32,Microsoft.VisualStudio.Shell.Interop.IVsProject[],System.Int32[],System.String[],Microsoft.VisualStudio.Shell.Interop.VSADDDIRECTORYFLAGS[])">
2126 <summary>Raised after directories have been added to a project.</summary>
2128 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2129 <param name="cProjects">The number of projects in the <paramref name="rgpProjects" /> array.</param>
2130 <param name="cDirectories">The number of directories to be added.</param>
2131 <param name="rgpProjects">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> objects, corresponding to the projects in the solution.</param>
2132 <param name="rgFirstIndices">An array of indices of the directories that were affected.</param>
2133 <param name="rgpszMkDocuments">An array of paths of the directories that were added.</param>
2134 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSADDDIRECTORYFLAGS" />. May be null.</param>
2136 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnAfterAddFilesEx(System.Int32,System.Int32,Microsoft.VisualStudio.Shell.Interop.IVsProject[],System.Int32[],System.String[],Microsoft.VisualStudio.Shell.Interop.VSADDFILEFLAGS[])">
2137 <summary>Raised after files have been added to a project.</summary>
2139 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2140 <param name="cProjects">The number of projects in the <paramref name="rgpProjects" /> array.</param>
2141 <param name="cFiles">The number of files to be added.</param>
2142 <param name="rgpProjects">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> objects.</param>
2143 <param name="rgFirstIndices">An array of indices of the files that were affected.</param>
2144 <param name="rgpszMkDocuments">An array of paths of the files that were affected.</param>
2145 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSADDFILEFLAGS" />. May be null.</param>
2147 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnAfterRemoveDirectories(System.Int32,System.Int32,Microsoft.VisualStudio.Shell.Interop.IVsProject[],System.Int32[],System.String[],Microsoft.VisualStudio.Shell.Interop.VSREMOVEDIRECTORYFLAGS[])">
2148 <summary>Raised after a directory was removed from the project.</summary>
2150 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2151 <param name="cProjects">The number of projects in the <paramref name="rgpProjects" /> array.</param>
2152 <param name="cDirectories">The number of directories affected.</param>
2153 <param name="rgpProjects">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> objects, corresponding to the projects in the solution.</param>
2154 <param name="rgFirstIndices">An array of indices of the directories that were affected.</param>
2155 <param name="rgpszMkDocuments">An array of paths of the directories that were affected. </param>
2156 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSREMOVEDIRECTORYFLAGS" />. May be null.</param>
2158 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnAfterRemoveFiles(System.Int32,System.Int32,Microsoft.VisualStudio.Shell.Interop.IVsProject[],System.Int32[],System.String[],Microsoft.VisualStudio.Shell.Interop.VSREMOVEFILEFLAGS[])">
2159 <summary>Raised after files have been removed from the project.</summary>
2161 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2162 <param name="cProjects">The number of projects in the <paramref name="rgpProjects" /> array.</param>
2163 <param name="cFiles">The number of files that were affected.</param>
2164 <param name="rgpProjects">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> objects, corresponding to the projects in the solution.</param>
2165 <param name="rgFirstIndices">An array of indices of the files that were affected.</param>
2166 <param name="rgpszMkDocuments">An array of paths of the files that were affected.</param>
2167 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSREMOVEFILEFLAGS" />. May be null.</param>
2169 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnAfterRenameDirectories(System.Int32,System.Int32,Microsoft.VisualStudio.Shell.Interop.IVsProject[],System.Int32[],System.String[],System.String[],Microsoft.VisualStudio.Shell.Interop.VSRENAMEDIRECTORYFLAGS[])">
2170 <summary>Raised after a directory has been moved or renamed.</summary>
2172 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2173 <param name="cProjects">The number of projects in the <paramref name="rgpProjects" /> array. </param>
2174 <param name="cDirs">The number of directories affected.</param>
2175 <param name="rgpProjects">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> objects, corresponding to the projects in the solution.</param>
2176 <param name="rgFirstIndices">An array of indices of the directories affected.</param>
2177 <param name="rgszMkOldNames">An array of the old paths of the directories.</param>
2178 <param name="rgszMkNewNames">An array of the new paths of the directories.</param>
2179 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSRENAMEDIRECTORYFLAGS" />. May be null.</param>
2181 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnAfterRenameFiles(System.Int32,System.Int32,Microsoft.VisualStudio.Shell.Interop.IVsProject[],System.Int32[],System.String[],System.String[],Microsoft.VisualStudio.Shell.Interop.VSRENAMEFILEFLAGS[])">
2182 <summary>Raised after files have been moved or renamed.</summary>
2184 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2185 <param name="cProjects">The number of projects in the <paramref name="rgpProjects" /> array. </param>
2186 <param name="cFiles">The number of files affected.</param>
2187 <param name="rgpProjects">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> objects, corresponding to the projects in the solution.</param>
2188 <param name="rgFirstIndices">An array of the indices of the files.</param>
2189 <param name="rgszMkOldNames">An array of the old paths of the files.</param>
2190 <param name="rgszMkNewNames">An array of the new paths of the files.</param>
2191 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSRENAMEFILEFLAGS" />. May be null.</param>
2193 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnAfterSccStatusChanged(System.Int32,System.Int32,Microsoft.VisualStudio.Shell.Interop.IVsProject[],System.Int32[],System.String[],System.UInt32[])">
2194 <summary>This method is called by the source code control component to inform listeners that source control status has changed. Do not call this method. </summary>
2196 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2197 <param name="cProjects">The number of projects in the <paramref name="rgpProjects" /> array.</param>
2198 <param name="cFiles">The number of files affected.</param>
2199 <param name="rgpProjects">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> objects, corresponding to the projects in the solution.</param>
2200 <param name="rgFirstIndices">An array of the indices of the files.</param>
2201 <param name="rgpszMkDocuments">An array of paths of the files. </param>
2202 <param name="rgdwSccStatus">An array of SccStatus flags. May be null.</param>
2204 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnQueryAddDirectories(Microsoft.VisualStudio.Shell.Interop.IVsProject,System.Int32,System.String[],Microsoft.VisualStudio.Shell.Interop.VSQUERYADDDIRECTORYFLAGS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYADDDIRECTORYRESULTS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYADDDIRECTORYRESULTS[])">
2205 <summary>Raised by a project to determine whether directories can be added to the project. Not used.</summary>
2207 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2208 <param name="pProject">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> affected.</param>
2209 <param name="cDirectories">The number of directories affected.</param>
2210 <param name="rgpszMkDocuments">An array of paths to the directories. </param>
2211 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYADDDIRECTORYFLAGS" />.</param>
2212 <param name="pSummaryResult">An array of summary <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYADDDIRECTORYRESULTS" /> objects, which represent a summary of the yes/no values returned.</param>
2213 <param name="rgResults">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYADDDIRECTORYRESULTS" />.</param>
2215 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnQueryAddFiles(Microsoft.VisualStudio.Shell.Interop.IVsProject,System.Int32,System.String[],Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILEFLAGS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILERESULTS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILERESULTS[])">
2216 <summary>Raised to determine whether files can be added to the project. Not used.</summary>
2218 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2219 <param name="pProject">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> affected.</param>
2220 <param name="cFiles">The number of files affected. </param>
2221 <param name="rgpszMkDocuments">An array of paths of the files.</param>
2222 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILEFLAGS" />.</param>
2223 <param name="pSummaryResult">An array of summary <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILERESULTS" /> objects, which represent a summary of the yes/no values returned.</param>
2224 <param name="rgResults">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILERESULTS" />.</param>
2226 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnQueryRemoveDirectories(Microsoft.VisualStudio.Shell.Interop.IVsProject,System.Int32,System.String[],Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYFLAGS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYRESULTS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYRESULTS[])">
2227 <summary>Raised to determine whether directories can be removed from the project. Not used.</summary>
2229 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2230 <param name="pProject">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> affected.</param>
2231 <param name="cDirectories">The number of directories affected.</param>
2232 <param name="rgpszMkDocuments">An array of paths of the directories.</param>
2233 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYFLAGS" />.</param>
2234 <param name="pSummaryResult">An array of summary <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYRESULTS" /> objects, which represent a summary of the yes/no values returned.</param>
2235 <param name="rgResults">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYRESULTS" />.</param>
2237 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnQueryRemoveFiles(Microsoft.VisualStudio.Shell.Interop.IVsProject,System.Int32,System.String[],Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILEFLAGS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILERESULTS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILERESULTS[])">
2238 <summary>Raised to determine whether files can be removed from the project. Not used.</summary>
2240 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2241 <param name="pProject">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> affected. </param>
2242 <param name="cFiles">The number of files affected.</param>
2243 <param name="rgpszMkDocuments">An array of paths to the files.</param>
2244 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILEFLAGS" />.</param>
2245 <param name="pSummaryResult">An array of summary <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILERESULTS" /> objects, which represent a summary of the yes/no values returned.</param>
2246 <param name="rgResults">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILERESULTS" />.</param>
2248 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnQueryRenameDirectories(Microsoft.VisualStudio.Shell.Interop.IVsProject,System.Int32,System.String[],System.String[],Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEDIRECTORYFLAGS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEDIRECTORYRESULTS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEDIRECTORYRESULTS[])">
2249 <summary>Raised to determine whether directories can be renamed in the project. Not used.</summary>
2251 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2252 <param name="pProject">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> affected.</param>
2253 <param name="cDirs">The number of directories affected. </param>
2254 <param name="rgszMkOldNames">An array of the old paths of the files.</param>
2255 <param name="rgszMkNewNames">An array of the new paths of the files.</param>
2256 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEDIRECTORYFLAGS" />.</param>
2257 <param name="pSummaryResult">An array of summary <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEDIRECTORYRESULTS" /> objects, which represent a summary of the yes/no values returned.</param>
2258 <param name="rgResults">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEFILERESULTS" />.</param>
2260 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsTrackProjectDocumentsEvents2#OnQueryRenameFiles(Microsoft.VisualStudio.Shell.Interop.IVsProject,System.Int32,System.String[],System.String[],Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEFILEFLAGS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEFILERESULTS[],Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEFILERESULTS[])">
2261 <summary>Raised to determine whether files can be renamed in the project. Not used.</summary>
2263 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2264 <param name="pProject">The <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsProject" /> affected.</param>
2265 <param name="cFiles">The number of files affected.</param>
2266 <param name="rgszMkOldNames">An array of the old paths of the files.</param>
2267 <param name="rgszMkNewNames">An array of the new paths of the files.</param>
2268 <param name="rgFlags">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEFILEFLAGS" />.</param>
2269 <param name="pSummaryResult">An array of summary <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEFILERESULTS" /> objects, which represent a summary of the yes/no values returned.</param>
2270 <param name="rgResults">An array of <see cref="T:Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEFILERESULTS" />.</param>
2272 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#AdviseHierarchyEvents(Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents,System.UInt32@)">
2273 <summary>Subscribes to hierarchy events.</summary>
2274 <returns>The cookie. </returns>
2275 <param name="pEventSink">
2276 <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents" />.</param>
2277 <param name="pdwCookie">A unique value, or cookie, that is needed to disable notification of hierarchy events.</param>
2279 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#Close">
2280 <summary>Closes the project and cleans up its resources once the environment determines that it is no longer used.</summary>
2282 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2284 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#ExecCommand(System.UInt32,System.Guid@,System.UInt32,System.UInt32,System.IntPtr,System.IntPtr)">
2285 <summary>Executes a command on a specific item within a UI hierarchy window, or on the hierarchy itself. </summary>
2286 <returns>If the method succeeded, <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />, otherwise an error code.</returns>
2287 <param name="itemid">The identifier of the item affected by the command. For single selection, this value is the actual item ID. For multiple selections, set <paramref name="itemid" /> equal to <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="VSITEMID_SELECTION" />.</param>
2288 <param name="pguidCmdGroup">Unique identifier of the command group. All the commands in <paramref name="nCmdID " />must belong to the group specified by <paramref name="pguidCmdGroup" />.</param>
2289 <param name="nCmdID">The command to be executed. This command must belong to the group specified with <paramref name="pguidCmdGroup" />.</param>
2290 <param name="nCmdexecopt">A member of the <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT" /> enumeration, describing the type of action to perform.</param>
2291 <param name="pvaIn">A pointer to a VARIANTARG structure containing input arguments. Can be null.</param>
2292 <param name="pvaOut">A pointer to a VARIANTARG structure to receive command output. Can be null.</param>
2294 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#GetCanonicalName(System.UInt32,System.String@)">
2295 <summary>Gets the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions.</summary>
2296 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="S_OK" />. If it fails, it returns an error code.</returns>
2297 <param name="itemid">The ID of the hierarchy item. </param>
2298 <param name="pbstrName">[out] The canonical name of the item.</param>
2300 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#GetGuidProperty(System.UInt32,System.Int32,System.Guid@)">
2301 <summary>Gets properties whose values are GUIDs.</summary>
2303 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2304 <param name="itemid">The item ID of the hierarchy node for which to get the property.</param>
2305 <param name="propid">The ID of the property.</param>
2306 <param name="pguid">[out] The GUID value.</param>
2308 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#GetNestedHierarchy(System.UInt32,System.Guid@,System.IntPtr@,System.UInt32@)">
2309 <summary>Determines whether or not a node is a nested hierarchy.</summary>
2310 <returns>If <paramref name="itemid" /> is not a nested hierarchy node, this method returns <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="E_FAIL" />. If the requested interface is not supported on the hierarchy object, <see cref="F:Microsoft.VisualStudio.VSConstants." /><see cref="E_NOINTERFACE" /> is returned. The caller would then treat this node as if it had no children. </returns>
2311 <param name="itemid">The item ID of the node.</param>
2312 <param name="iidHierarchyNested">The interface ID of the node.</param>
2313 <param name="ppHierarchyNested">[out] Returns a pointer to the node, if it is a nested hierarchy node. </param>
2314 <param name="pitemidNested">[out] Returns the item ID of the nested hierarchy node; this will always be <see cref="F:Microsoft.VisualStudio.VSConstants.VSITEMID_ROOT" />.</param>
2316 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#GetProperty(System.UInt32,System.Int32,System.Object@)">
2317 <summary>Gets the value of a property for a given node.</summary>
2318 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2319 <param name="itemid">The item ID of the node.</param>
2320 <param name="propid">The ID of the requested property.</param>
2321 <param name="pvar">[out] The value of the property.</param>
2323 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#GetSite(Microsoft.VisualStudio.OLE.Interop.IServiceProvider@)">
2324 <summary>Gets the service provider from which to access the services.</summary>
2326 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2327 <param name="ppSP">[out] <see cref="T:Microsoft.VisualStudio.OLE.Interop.IServiceProvider" />.</param>
2329 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#ParseCanonicalName(System.String,System.UInt32@)">
2330 <summary>Returns the identifier of the hierarchy item, given its canonical name. </summary>
2331 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2332 <param name="pszName">The canonical name of the item.</param>
2333 <param name="pitemid">[out] The ID of the item.</param>
2335 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#QueryClose(System.Int32@)">
2336 <summary>Determines whether the hierarchy can be closed. </summary>
2337 <returns>true if the hierarchy can be closed, otherwise false.</returns>
2338 <param name="pfCanClose">[out] Returns true if the hierarchy can be closed, otherwise false.</param>
2340 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#QueryStatusCommand(System.UInt32,System.Guid@,System.UInt32,Microsoft.VisualStudio.OLE.Interop.OLECMD[],System.IntPtr)">
2341 <summary>Gets the status of the specified commands.</summary>
2342 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2343 <param name="itemid">The ID of the item being queried.</param>
2344 <param name="pguidCmdGroup">The GUID of the command group to which the commands belong.</param>
2345 <param name="cCmds">The number of commands in the <paramref name="prgCmds" /> array.</param>
2346 <param name="prgCmds">An array of command <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMD" /> structures with information on the commands.</param>
2347 <param name="pCmdText">A pointer to an <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDTEXT" /> structure containing name and/or status information on the command.</param>
2349 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#SetGuidProperty(System.UInt32,System.Int32,System.Guid@)">
2350 <summary>Sets properties whose values are GUIDs. </summary>
2351 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2352 <param name="itemid">The ID of the item.</param>
2353 <param name="propid">The ID of the property to set.</param>
2354 <param name="rguid">The GUID value of the property.</param>
2356 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#SetProperty(System.UInt32,System.Int32,System.Object)">
2357 <summary>Sets properties of a specific node or of the hierarchy. </summary>
2358 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2359 <param name="itemid">The ID of the item.</param>
2360 <param name="propid">The ID of the property to set.</param>
2361 <param name="var">The value of the property.</param>
2363 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#SetSite(Microsoft.VisualStudio.OLE.Interop.IServiceProvider)">
2364 <summary>Sets the service provider from which to access the services. </summary>
2366 <see cref="F:Microsoft.VisualStudio.NativeMethods.S_OK" />.</returns>
2368 <see cref="T:Microsoft.VisualStudio.OLE.Interop.IServiceProvider" />.</param>
2370 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#UnadviseHierarchyEvents(System.UInt32)">
2371 <summary>Disables client notification of hierarchy events.</summary>
2372 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2373 <param name="dwCookie">The unique identifier that was handed back with <see cref="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.AdviseHierarchyEvents(Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents)" />.</param>
2375 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#Unused0">
2376 <summary>A placeholder for a future method.</summary>
2377 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2379 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#Unused1">
2380 <summary>A placeholder for a future method.</summary>
2381 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2383 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#Unused2">
2384 <summary>A placeholder for a future method.</summary>
2385 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2387 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#Unused3">
2388 <summary>A placeholder for a future method.</summary>
2389 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2391 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Microsoft#VisualStudio#Shell#Interop#IVsUIHierarchy#Unused4">
2392 <summary>A placeholder for a future method.</summary>
2393 <returns>Implementers should return <see cref="F:Microsoft.VisualStudio.VSConstants.E_NOTIMPL" />.</returns>
2395 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.OnAggregationComplete">
2396 <summary>Subscribes to <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsTrackProjectDocumentsEvents2" /> events. It is not required to flavor a project but makes it easier for derived classes to subscribe to these events.</summary>
2398 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.ParseCanonicalName(System.String,System.UInt32@)">
2399 <summary>Returns the identifier of the hierarchy item, given its canonical name. </summary>
2400 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2401 <param name="name">The canonical name of the item.</param>
2402 <param name="itemId">[out] The ID of the item.</param>
2404 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.QueryClose">
2405 <summary>Determines whether the hierarchy can be closed. </summary>
2406 <returns>true if the hierarchy can be closed, otherwise false.</returns>
2408 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.QueryStatusCommand(System.UInt32,System.Guid@,System.UInt32,Microsoft.VisualStudio.OLE.Interop.OLECMD[],System.IntPtr)">
2409 <summary>Gets the status of the specified commands.</summary>
2410 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2411 <param name="itemid">The ID of the item being queried.</param>
2412 <param name="pguidCmdGroup">The GUID of the command group to which the commands belong.</param>
2413 <param name="cCmds">The number of commands in the <paramref name="prgCmds" /> array.</param>
2414 <param name="prgCmds">An array of command <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMD" /> structures with information on the commands.</param>
2415 <param name="pCmdText">A pointer to an <see cref="T:Microsoft.VisualStudio.OLE.Interop.OLECMDTEXT" /> structure containing name and/or status information on the command.</param>
2417 <member name="E:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.SccStatusChanged">
2418 <summary>Raised after the source code control status of an item in the project has changed.</summary>
2420 <member name="F:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.serviceProvider">
2421 <summary>The service provider of the project.</summary>
2423 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.SetGuidProperty(System.UInt32,System.Int32,System.Guid@)">
2424 <summary>Sets properties whose values are GUIDs. </summary>
2425 <param name="itemId">The ID of the item.</param>
2426 <param name="propId">The ID of the property to set.</param>
2427 <param name="guid">The GUID value of the property.</param>
2429 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.SetInnerProject(System.Object)">
2430 <summary>Sets up the interfaces and menu commands for the inner project. </summary>
2431 <param name="inner">The inner project subtype.</param>
2433 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.SetProperty(System.UInt32,System.Int32,System.Object)">
2434 <summary>Sets properties of a specific node or of the hierarchy. </summary>
2435 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" /> . If it fails, it returns an error code.</returns>
2436 <param name="itemId">The ID of the item.</param>
2437 <param name="propId">The ID of the property to set.</param>
2438 <param name="property">The value of the property.</param>
2440 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.System#IServiceProvider#GetService(System.Type)">
2441 <summary>Gets the service of the specified type.</summary>
2442 <returns>A service of the type specified. </returns>
2443 <param name="serviceType">The type of the service.</param>
2445 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.UnadviseHierarchyEvents(System.UInt32)">
2446 <summary>Disables client notification of hierarchy events.</summary>
2447 <param name="cookie">The unique identifier that was handed back with <see cref="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.AdviseHierarchyEvents(Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents)" />.</param>
2449 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Unused0">
2450 <summary>A placeholder for a future method.</summary>
2452 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Unused1">
2453 <summary>A placeholder for a future method.</summary>
2455 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Unused2">
2456 <summary>A placeholder for a future method.</summary>
2458 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Unused3">
2459 <summary>A placeholder for a future method.</summary>
2461 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.Unused4">
2462 <summary>A placeholder for a future method.</summary>
2464 <member name="T:Microsoft.VisualStudio.Shell.Flavor.FlavoredProject.EventHandler`1">
2465 <summary>Represents the method that handles events that relate to files and folders of the flavored project.</summary>
2466 <param name="sender">The object that raises the event.</param>
2468 <see cref="T:Microsoft.VisualStudio.Package.Flavor.ProjectDocumentsChangeEventArgs" />.</param>
2469 <typeparam name="ProjectDocumentsChangeEventArgs"></typeparam>
2471 <member name="T:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectBase.EventHandler`1">
2472 <typeparam name="ProjectDocumentsChangeEventArgs"></typeparam>
2474 <member name="T:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase">
2475 <summary>Base class for flavored project factories.</summary>
2477 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.#ctor">
2478 <summary>Initializes a new instance of <see cref="T:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase" />.</summary>
2480 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.CanCreateProject(System.String,System.UInt32)">
2481 <summary>Determines whether or not the project can be created with the supplied parameters.</summary>
2482 <returns>true if the project file name is valid, otherwise false.</returns>
2483 <param name="fileName">The name of the file.</param>
2484 <param name="flags">Not used.</param>
2486 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.CreateProject(System.String,System.String,System.String,System.UInt32,System.Guid@,System.IntPtr@,System.Int32@)">
2487 <summary>Creates a project.</summary>
2488 <param name="fileName">The name of the project file.</param>
2489 <param name="location">The path of the project file. </param>
2490 <param name="name">The name of the project.</param>
2491 <param name="flags">Values from <see cref="T:Microsoft.VisualStudio.Shell.Interop.__VSCREATEPROJFLAGS" />.</param>
2492 <param name="projectGuid">The interface ID of the project.</param>
2493 <param name="project">[out] Returns a pointer to the project.</param>
2494 <param name="canceled">[out] Returns true if the operation was canceled, otherwise false.</param>
2496 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.Dispose(System.Boolean)">
2497 <summary>Disposes the service provider.</summary>
2498 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
2500 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.Initialize">
2501 <summary>Initializes the project factory.</summary>
2503 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.Microsoft#VisualStudio#Shell#Flavor#IVsAggregatableProjectFactoryCorrected#GetAggregateProjectType(System.String,System.String@)"></member>
2504 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.Microsoft#VisualStudio#Shell#Flavor#IVsAggregatableProjectFactoryCorrected#PreCreateForOuter(System.IntPtr,System.IntPtr@)"></member>
2505 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.Microsoft#VisualStudio#Shell#Interop#IVsProjectFactory#CanCreateProject(System.String,System.UInt32,System.Int32@)"></member>
2506 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.Microsoft#VisualStudio#Shell#Interop#IVsProjectFactory#Close"></member>
2507 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.Microsoft#VisualStudio#Shell#Interop#IVsProjectFactory#CreateProject(System.String,System.String,System.String,System.UInt32,System.Guid@,System.IntPtr@,System.Int32@)"></member>
2508 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.Microsoft#VisualStudio#Shell#Interop#IVsProjectFactory#SetSite(Microsoft.VisualStudio.OLE.Interop.IServiceProvider)"></member>
2509 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.PreCreateForOuter(System.IntPtr)">
2510 <summary>Creates an instance of the project. </summary>
2511 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2512 <param name="outerProjectIUnknown">The outermost project, or null if the outer project is being created.</param>
2514 <member name="M:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.ProjectTypeGuids(System.String)">
2515 <summary>Gets the set of project type GUIDs from the project file.</summary>
2516 <returns>When implemented by a derived class, a semicolon-delimited string containing the project type GUIDs in the project file.</returns>
2517 <param name="file">The project file.</param>
2519 <member name="P:Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase.serviceProvider">
2520 <summary>Gets the project's service provider.</summary>
2522 <see cref="T:Microsoft.VisualStudio.Shell.ServiceProvider" />.</returns>
2524 <member name="T:Microsoft.VisualStudio.Shell.Flavor.ILocalRegistryCorrected">
2525 <summary>Establishes a locally-registered COM object relative to the local Visual Studio registry hive.</summary>
2527 <member name="M:Microsoft.VisualStudio.Shell.Flavor.ILocalRegistryCorrected.CreateInstance(System.Guid,System.IntPtr,System.Guid@,System.UInt32,System.IntPtr@)">
2528 <summary>Creates an instance of a class listed in the local registry.</summary>
2529 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2530 <param name="clsid">[in] Class identifier (CLSID) of the requested object. This is the CLSID associated with the data and code that is used to create the object.</param>
2531 <param name="punkOuterIUnknown">[in] Pointer to the IUnknown interface of the newly created object. A value of null indicates that the object is not being created as part of an aggregate. If non-null, this is a pointer to the aggregate object's IUnknown.</param>
2532 <param name="riid">[in] Interface to be used to communicate with the object. For example, IID_IClassFactory.</param>
2533 <param name="dwFlags">[in] Flags controlling the instance creation from the <see cref="T:Microsoft.VisualStudio.OLE.Interop.CLSCTX" /> enumeration. Specifies a value of <see cref="F:Microsoft.VisualStudio.OLE.Interop.CLSCTX.CLSCTX_INPROC_SERVER" />.</param>
2534 <param name="ppvObj">[out] Address of pointer variable that receives the interface pointer requested in <paramref name="riid" />. Upon successful return, <paramref name="ppvObj" /> contains the requested interface pointer. Upon failure, <paramref name="ppvObj" /> contains null.</param>
2536 <member name="M:Microsoft.VisualStudio.Shell.Flavor.ILocalRegistryCorrected.GetClassObjectOfClsid(System.Guid@,System.UInt32,System.IntPtr,System.Guid@,System.IntPtr@)">
2537 <summary>Returns the class object associated with a CLSID.</summary>
2538 <returns>If the method succeeds, it returns <see cref="F:Microsoft.VisualStudio.VSConstants.S_OK" />. If it fails, it returns an error code.</returns>
2539 <param name="clsid">[in] Class identifier (CLSID) of the requested object. This is the CLSID associated with the data and code that is used to create the object.</param>
2540 <param name="dwFlags">[in] Flags controlling the instance creation from the <see cref="T:Microsoft.VisualStudio.OLE.Interop.CLSCTX" /> enumeration. Specifies a value of <see cref="F:Microsoft.VisualStudio.OLE.Interop.CLSCTX.CLSCTX_INPROC_SERVER" />.</param>
2541 <param name="lpReserved">[in] Reserved.</param>
2542 <param name="riid">[in] Interface to be used to communicate with the object. For example, IID_IClassFactory.</param>
2543 <param name="ppvClassObject">[in] Address of pointer variable that receives the interface pointer requested in <paramref name="riid" />. Upon successful return, <paramref name="ppvObj" /> contains the requested interface pointer. Upon failure, <paramref name="ppvObj" /> contains null.</param>
2545 <member name="M:Microsoft.VisualStudio.Shell.Flavor.ILocalRegistryCorrected.GetTypeLibOfClsid(System.Guid,Microsoft.VisualStudio.OLE.Interop.ITypeLib@)">
2546 <summary>Not implemented. Do not use.</summary>
2547 <param name="clsid">Do not use.</param>
2548 <param name="pptLib">Do not use.</param>