C# Class Microsoft.VisualStudio.Project.NestedProjectNode

Inheritance: HierarchyNode, IPropertyNotifySink
Exibir arquivo Open project: tunnelvisionlabs/MPFProj10 Class Usage Examples

Public Methods

Method Description
AddVirtualProject ( ) : void

Links a nested project as a virtual project to the solution.

Close ( ) : int

Return S_OK. Implementation of Closing a nested project is done in CloseNestedProject which is called by CloseChildren.

CloseNestedProjectNode ( ) : void

Closes a nested project and releases the nested hierarchy pointer.

GetAddFileFlags ( string files ) : VSADDFILEFLAGS[]

Sets the VSADDFILEFLAGS that will be used to call the IVsTrackProjectDocumentsEvents2 OnAddFiles

GetAutomationObject ( ) : object

Get the automation object for the NestedProjectNode

GetEditLabel ( ) : string

Called by the shell to get the node caption when the user tries to rename from the GUI

GetGuidProperty ( int propid, System.Guid &guid ) : int

Gets properties whose values are GUIDs.

GetIconHandle ( bool open ) : object

Gets the icon handle. It tries first the nested to get the icon handle. If that is not supported it will get it from the image list of the nested if that is supported. If neither of these is supported a default image will be shown.

GetMKDocument ( ) : string

Returns the moniker of the nested project.

GetProperty ( int propId ) : object

Gets properties of a given node or of the hierarchy.

GetQueryAddFileFlags ( string files ) : VSQUERYADDFILEFLAGS[]

Sets the VSQUERYADDFILEFLAGS that will be used to call the IVsTrackProjectDocumentsEvents2 OnQueryAddFiles

GetQueryRemoveFileFlags ( string files ) : VSQUERYREMOVEFILEFLAGS[]

Sets the VSQUERYREMOVEFILEFLAGS that will be used to call the IVsTrackProjectDocumentsEvents2 OnQueryRemoveFiles

GetRemoveFileFlags ( string files ) : VSREMOVEFILEFLAGS[]

Sets the VSREMOVEFILEFLAGS that will be used to call the IVsTrackProjectDocumentsEvents2 OnRemoveFiles

IgnoreItemFileChanges ( bool ignoreFlag ) : void

Flag indicating that changes to a file can be ignored when item is saved or reloaded.

Init ( string fileName, string destination, string projectName, __VSCREATEPROJFLAGS createFlags ) : void

Initialize the nested hierarhy node.

This methos should be called just after a NestedProjectNode object is created.

IsItemDirty ( uint itemId, IntPtr punkDocData, int &pfDirty ) : int

Determines whether the hierarchy item changed.

NestedProjectNode ( ProjectNode root, ProjectElement element ) : System
OnChanged ( int dispid ) : void

Notifies a sink that the [bindable] property specified by dispID has changed. If dispID is DISPID_UNKNOWN, then multiple properties have changed together. The client (owner of the sink) should then retrieve the current value of each property of interest from the object that generated the notification. In our case we will care about the VSLangProj80.VsProjPropId.VBPROJPROPID_FileName and update the changes in the parent project file.

OnRequestEdit ( int dispid ) : void

Notifies a sink that a [requestedit] property is about to change and that the object is asking the sink how to proceed.

ReloadItem ( uint reserved ) : void

Delegates the call to the inner hierarchy.

SaveItem ( VSSAVEFLAGS dwSave, string silentSaveAsName, uint itemid, IntPtr punkDocData, int &pfCancelled ) : int

Saves the hierarchy item to disk.

SetEditLabel ( string label ) : int

Called by the shell when a node has been renamed from the GUI

Protected Methods

Method Description
CanDeleteItem ( __VSDELETEITEMOPERATION deleteOperation ) : bool

This is temporary until we have support for re-adding a nested item

ConnectPropertyNotifySink ( ) : void

We need to advise property notify sink on project properties so that we know when the project file is renamed through a property.

CreateProjectDirectory ( ) : void

Creates the project directory if it does not exist.

DelegateGetPropertyToNested ( int propID ) : object

Delegates GetProperty calls to the inner nested.

DelegateSetPropertyToNested ( int propID, object value ) : int

Delegates SetProperty calls to the inner nested.

DisconnectPropertyNotifySink ( ) : void

Disconnects the PropertyNotify sink

Dispose ( bool disposing ) : void

The method that does the cleanup.

GetConnectionPointFromPropertySink ( ) : IConnectionPoint

Gets a ConnectionPoint for the IPropertyNotifySink interface.

IgnoreNestedProjectFile ( bool ignoreFlag ) : void

Ignores observing changes on this file depending on the boolean flag.

InitImageHandler ( ) : void
InitializeInstanceGuid ( ) : void
ObserveNestedProjectFile ( ) : void

Starts observing changes on this file.

RenameNestedProjectInParentProject ( string label ) : void

Renames the project file in the parent project structure.

SaveNestedProjectItemInProjectFile ( string newFileName ) : void

Saves the nested project information in the project file.

SetDocCookieOnNestedHier ( uint itemDocCookie ) : void
StopObservingNestedProjectFile ( ) : void

Stops observing changes on this file.

Private Methods

Method Description
LockRdtEntry ( ) : void
UnlockRdtEntry ( ) : void

Method Details

AddVirtualProject() public method

Links a nested project as a virtual project to the solution.
public AddVirtualProject ( ) : void
return void

CanDeleteItem() protected method

This is temporary until we have support for re-adding a nested item
protected CanDeleteItem ( __VSDELETEITEMOPERATION deleteOperation ) : bool
deleteOperation __VSDELETEITEMOPERATION
return bool

Close() public method

Return S_OK. Implementation of Closing a nested project is done in CloseNestedProject which is called by CloseChildren.
public Close ( ) : int
return int

CloseNestedProjectNode() public method

Closes a nested project and releases the nested hierarchy pointer.
public CloseNestedProjectNode ( ) : void
return void

ConnectPropertyNotifySink() protected method

We need to advise property notify sink on project properties so that we know when the project file is renamed through a property.
protected ConnectPropertyNotifySink ( ) : void
return void

CreateProjectDirectory() protected method

Creates the project directory if it does not exist.
protected CreateProjectDirectory ( ) : void
return void

DelegateGetPropertyToNested() protected method

Delegates GetProperty calls to the inner nested.
protected DelegateGetPropertyToNested ( int propID ) : object
propID int The property to delegate.
return object

DelegateSetPropertyToNested() protected method

Delegates SetProperty calls to the inner nested.
protected DelegateSetPropertyToNested ( int propID, object value ) : int
propID int The property to delegate.
value object The property to set.
return int

DisconnectPropertyNotifySink() protected method

Disconnects the PropertyNotify sink
protected DisconnectPropertyNotifySink ( ) : void
return void

Dispose() protected method

The method that does the cleanup.
protected Dispose ( bool disposing ) : void
disposing bool
return void

GetAddFileFlags() public method

Sets the VSADDFILEFLAGS that will be used to call the IVsTrackProjectDocumentsEvents2 OnAddFiles
public GetAddFileFlags ( string files ) : VSADDFILEFLAGS[]
files string The files to which an array of VSADDFILEFLAGS has to be specified.
return VSADDFILEFLAGS[]

GetAutomationObject() public method

Get the automation object for the NestedProjectNode
public GetAutomationObject ( ) : object
return object

GetConnectionPointFromPropertySink() protected method

Gets a ConnectionPoint for the IPropertyNotifySink interface.
protected GetConnectionPointFromPropertySink ( ) : IConnectionPoint
return IConnectionPoint

GetEditLabel() public method

Called by the shell to get the node caption when the user tries to rename from the GUI
public GetEditLabel ( ) : string
return string

GetGuidProperty() public method

Gets properties whose values are GUIDs.
public GetGuidProperty ( int propid, System.Guid &guid ) : int
propid int Identifier of the hierarchy property
guid System.Guid Pointer to a GUID property specified in propid
return int

GetIconHandle() public method

Gets the icon handle. It tries first the nested to get the icon handle. If that is not supported it will get it from the image list of the nested if that is supported. If neither of these is supported a default image will be shown.
public GetIconHandle ( bool open ) : object
open bool
return object

GetMKDocument() public method

Returns the moniker of the nested project.
public GetMKDocument ( ) : string
return string

GetProperty() public method

Gets properties of a given node or of the hierarchy.
public GetProperty ( int propId ) : object
propId int Identifier of the hierarchy property
return object

GetQueryAddFileFlags() public method

Sets the VSQUERYADDFILEFLAGS that will be used to call the IVsTrackProjectDocumentsEvents2 OnQueryAddFiles
public GetQueryAddFileFlags ( string files ) : VSQUERYADDFILEFLAGS[]
files string The files to which an array of VSADDFILEFLAGS has to be specified.
return VSQUERYADDFILEFLAGS[]

GetQueryRemoveFileFlags() public method

Sets the VSQUERYREMOVEFILEFLAGS that will be used to call the IVsTrackProjectDocumentsEvents2 OnQueryRemoveFiles
public GetQueryRemoveFileFlags ( string files ) : VSQUERYREMOVEFILEFLAGS[]
files string The files to which an array of VSQUERYREMOVEFILEFLAGS has to be specified.
return VSQUERYREMOVEFILEFLAGS[]

GetRemoveFileFlags() public method

Sets the VSREMOVEFILEFLAGS that will be used to call the IVsTrackProjectDocumentsEvents2 OnRemoveFiles
public GetRemoveFileFlags ( string files ) : VSREMOVEFILEFLAGS[]
files string The files to which an array of VSREMOVEFILEFLAGS has to be specified.
return VSREMOVEFILEFLAGS[]

IgnoreItemFileChanges() public method

Flag indicating that changes to a file can be ignored when item is saved or reloaded.
public IgnoreItemFileChanges ( bool ignoreFlag ) : void
ignoreFlag bool Flag indicating whether or not to ignore changes (1 to ignore, 0 to stop ignoring).
return void

IgnoreNestedProjectFile() protected method

Ignores observing changes on this file depending on the boolean flag.
protected IgnoreNestedProjectFile ( bool ignoreFlag ) : void
ignoreFlag bool Flag indicating whether or not to ignore changes (1 to ignore, 0 to stop ignoring).
return void

Init() public method

Initialize the nested hierarhy node.
This methos should be called just after a NestedProjectNode object is created.
public Init ( string fileName, string destination, string projectName, __VSCREATEPROJFLAGS createFlags ) : void
fileName string The file name of the nested project.
destination string The location of the nested project.
projectName string The name of the project.
createFlags __VSCREATEPROJFLAGS The nested project creation flags
return void

InitImageHandler() protected method

protected InitImageHandler ( ) : void
return void

InitializeInstanceGuid() protected method

protected InitializeInstanceGuid ( ) : void
return void

IsItemDirty() public method

Determines whether the hierarchy item changed.
public IsItemDirty ( uint itemId, IntPtr punkDocData, int &pfDirty ) : int
itemId uint Item identifier of the hierarchy item contained in VSITEMID
punkDocData System.IntPtr Pointer to the IUnknown interface of the hierarchy item.
pfDirty int TRUE if the hierarchy item changed.
return int

NestedProjectNode() public method

public NestedProjectNode ( ProjectNode root, ProjectElement element ) : System
root ProjectNode
element ProjectElement
return System

ObserveNestedProjectFile() protected method

Starts observing changes on this file.
protected ObserveNestedProjectFile ( ) : void
return void

OnChanged() public method

Notifies a sink that the [bindable] property specified by dispID has changed. If dispID is DISPID_UNKNOWN, then multiple properties have changed together. The client (owner of the sink) should then retrieve the current value of each property of interest from the object that generated the notification. In our case we will care about the VSLangProj80.VsProjPropId.VBPROJPROPID_FileName and update the changes in the parent project file.
public OnChanged ( int dispid ) : void
dispid int Dispatch identifier of the property that is about to change or DISPID_UNKNOWN if multiple properties are about to change.
return void

OnRequestEdit() public method

Notifies a sink that a [requestedit] property is about to change and that the object is asking the sink how to proceed.
public OnRequestEdit ( int dispid ) : void
dispid int Dispatch identifier of the property that is about to change or DISPID_UNKNOWN if multiple properties are about to change.
return void

ReloadItem() public method

Delegates the call to the inner hierarchy.
public ReloadItem ( uint reserved ) : void
reserved uint Reserved parameter defined at the IVsPersistHierarchyItem2::ReloadItem parameter.
return void

RenameNestedProjectInParentProject() protected method

Renames the project file in the parent project structure.
protected RenameNestedProjectInParentProject ( string label ) : void
label string The new label.
return void

SaveItem() public method

Saves the hierarchy item to disk.
public SaveItem ( VSSAVEFLAGS dwSave, string silentSaveAsName, uint itemid, IntPtr punkDocData, int &pfCancelled ) : int
dwSave VSSAVEFLAGS Flags whose values are taken from the VSSAVEFLAGS enumeration.
silentSaveAsName string File name to be applied when dwSave is set to VSSAVE_SilentSave.
itemid uint Item identifier of the hierarchy item saved from VSITEMID.
punkDocData System.IntPtr Pointer to the IUnknown interface of the hierarchy item saved.
pfCancelled int TRUE if the save action was canceled.
return int

SaveNestedProjectItemInProjectFile() protected method

Saves the nested project information in the project file.
protected SaveNestedProjectItemInProjectFile ( string newFileName ) : void
newFileName string
return void

SetDocCookieOnNestedHier() protected method

protected SetDocCookieOnNestedHier ( uint itemDocCookie ) : void
itemDocCookie uint
return void

SetEditLabel() public method

Called by the shell when a node has been renamed from the GUI
public SetEditLabel ( string label ) : int
label string The name of the new label.
return int

StopObservingNestedProjectFile() protected method

Stops observing changes on this file.
protected StopObservingNestedProjectFile ( ) : void
return void