Export (0) Print
Expand All

FlavoredProject Class

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.

Namespace:  Microsoft.VisualStudio.Shell.Flavor
Assembly:  Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

public abstract class FlavoredProject : CProjectAggregatorClass, 
	IVsAggregatableProject, IServiceProvider, IVsHierarchy, IVsUIHierarchy, IOleCommandTarget, 
	IVsTrackProjectDocumentsEvents2

The FlavoredProject type exposes the following members.

  NameDescription
Public methodFlavoredProjectWhen overridden in a derived class, initializes an instance of the FlavoredProject class.
Top

  NameDescription
Protected methodAdviseHierarchyEventsSubscribes to hierarchy events.
Protected methodCloseCloses and cleans up a hierarchy once the environment determines that it is no longer used.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExecCommandExecutes a command on a specific item within a UI hierarchy window, or on the hierarchy itself.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetCanonicalNameGets the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions.
Protected methodGetGuidPropertyGets properties whose values are GUIDs.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetNestedHierarchyDetermines whether or not a node is a nested hierarchy.
Protected methodGetPropertyGets the value of a property for a given node.
Protected methodGetSiteGets the service provider from which to access the services.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializeForOuterCalled by the outer project subtype to have the owned inner project subtype do its initialization work.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnAggregationCompleteSubscribes to IVsTrackProjectDocumentsEvents2 events. It is not required to flavor a project but makes it easier for derived classes to subscribe to these events.
Protected methodParseCanonicalNameReturns the identifier of the hierarchy item, given its canonical name.
Protected methodQueryCloseDetermines whether the hierarchy can be closed.
Protected methodQueryStatusCommandGets the status of the specified commands.
Protected methodSetGuidPropertySets properties whose values are GUIDs.
Public methodSetInnerSets the inner project. (Inherited from CProjectAggregatorClass.)
Protected methodSetInnerProjectSets up the interfaces and menu commands for the inner project.
Protected methodSetPropertySets properties of a specific node or of the hierarchy.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnadviseHierarchyEventsDisables client notification of hierarchy events.
Protected methodUnused0A placeholder for a future method.
Protected methodUnused1A placeholder for a future method.
Protected methodUnused2A placeholder for a future method.
Protected methodUnused3A placeholder for a future method.
Protected methodUnused4A placeholder for a future method.
Top

  NameDescription
Public eventDirectoryAddedRaised after a directory has been added to the project.
Public eventDirectoryRemovedRaised after a directory has been removed from the project.
Public eventDirectoryRenamedRaised after a directory in the project has been renamed.
Public eventFileAddedRaised after a file has been added to the project.
Public eventFileRemovedRaised after a file has been removed from the project.
Public eventFileRenamedRaised after a file in the project has been renamed.
Public eventSccStatusChangedRaised after the source code control status of an item in the project has changed.
Top

  NameDescription
Public Extension MethodIsCapabilityMatchChecks whether a given project matches the requirements prescribed in an AppliesTo expression. (Defined by PackageUtilities.)
Top

  NameDescription
Protected fieldinnerOleCommandTargetThe IOleCommandTarget interface of the inner project.
Protected fieldinnerVsAggregatableProjectThe IVsAggregatableProject of the inner project.
Protected fieldinnerVsHierarchyThe IVsHierarchy interface of the inner project.
Protected fieldinnerVsUIHierarchyThe IVsUIHierarchy interface of the inner project.
Protected fieldserviceProviderThe service provider of the project.
Top

  NameDescription
Explicit interface implemetationPrivate methodIServiceProvider.GetServiceGets the service of the specified type.
Explicit interface implemetationPrivate methodIOleCommandTarget.ExecExecutes a specified command or displays help for a command.
Explicit interface implemetationPrivate methodIOleCommandTarget.QueryStatusQueries the object for the status of one or more commands.
Explicit interface implemetationPrivate methodIVsAggregatableProject.GetAggregateProjectTypeGuidsGets 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.
Explicit interface implemetationPrivate methodIVsAggregatableProject.InitializeForOuterCalled by the outer project subtype to have the inner project subtype do its initialization work.
Explicit interface implemetationPrivate methodIVsAggregatableProject.OnAggregationCompleteCalled to continue initialization after aggregation is complete.
Explicit interface implemetationPrivate methodIVsAggregatableProject.SetAggregateProjectTypeGuidsUpdates the list of GUIDs that are persisted in the project file of the base project.
Explicit interface implemetationPrivate methodIVsAggregatableProject.SetInnerProjectSets up the inner project as well as the necessary interface pointers.
Explicit interface implemetationPrivate methodIVsHierarchy.AdviseHierarchyEventsSubscribes to hierarchy events.
Explicit interface implemetationPrivate methodIVsHierarchy.CloseCloses and cleans up a hierarchy once the environment determines that it is no longer used.
Explicit interface implemetationPrivate methodIVsHierarchy.GetCanonicalNameGets a unique name for an item in the hierarchy. Used for workspace persistence, such as remembering window positions.
Explicit interface implemetationPrivate methodIVsHierarchy.GetGuidPropertyGets properties whose values are GUIDs.
Explicit interface implemetationPrivate methodIVsHierarchy.GetNestedHierarchyDetermines whether or not a node is a nested hierarchy.
Explicit interface implemetationPrivate methodIVsHierarchy.GetPropertyGets properties of a given node or of the hierarchy.
Explicit interface implemetationPrivate methodIVsHierarchy.GetSiteGets the service provider from which to access the services.
Explicit interface implemetationPrivate methodIVsHierarchy.ParseCanonicalNameReturns the identifier of the hierarchy item, given its canonical name.
Explicit interface implemetationPrivate methodIVsHierarchy.QueryCloseDetermines whether the hierarchy can be closed.
Explicit interface implemetationPrivate methodIVsHierarchy.SetGuidPropertySets properties whose values are GUIDs.
Explicit interface implemetationPrivate methodIVsHierarchy.SetPropertySets properties of a specific node or of the hierarchy.
Explicit interface implemetationPrivate methodIVsHierarchy.SetSiteSets the service provider from which to access the services.
Explicit interface implemetationPrivate methodIVsHierarchy.UnadviseHierarchyEventsDisables client notification of hierarchy events.
Explicit interface implemetationPrivate methodIVsHierarchy.Unused0A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsHierarchy.Unused1A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsHierarchy.Unused2A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsHierarchy.Unused3A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsHierarchy.Unused4A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnAfterAddDirectoriesExRaised after directories have been added to a project.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnAfterAddFilesExRaised after files have been added to a project.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnAfterRemoveDirectoriesRaised after a directory was removed from the project.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnAfterRemoveFilesRaised after files have been removed from the project.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnAfterRenameDirectoriesRaised after a directory has been moved or renamed.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnAfterRenameFilesRaised after files have been moved or renamed.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnAfterSccStatusChangedThis method is called by the source code control component to inform listeners that source control status has changed. Do not call this method.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnQueryAddDirectoriesRaised by a project to determine whether directories can be added to the project. Not used.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnQueryAddFilesRaised to determine whether files can be added to the project. Not used.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnQueryRemoveDirectoriesRaised to determine whether directories can be removed from the project. Not used.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnQueryRemoveFilesRaised to determine whether files can be removed from the project. Not used.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnQueryRenameDirectoriesRaised to determine whether directories can be renamed in the project. Not used.
Explicit interface implemetationPrivate methodIVsTrackProjectDocumentsEvents2.OnQueryRenameFilesRaised to determine whether files can be renamed in the project. Not used.
Explicit interface implemetationPrivate methodIVsUIHierarchy.AdviseHierarchyEventsSubscribes to hierarchy events.
Explicit interface implemetationPrivate methodIVsUIHierarchy.CloseCloses the project and cleans up its resources once the environment determines that it is no longer used.
Explicit interface implemetationPrivate methodIVsUIHierarchy.ExecCommandExecutes a command on a specific item within a UI hierarchy window, or on the hierarchy itself.
Explicit interface implemetationPrivate methodIVsUIHierarchy.GetCanonicalNameGets the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions.
Explicit interface implemetationPrivate methodIVsUIHierarchy.GetGuidPropertyGets properties whose values are GUIDs.
Explicit interface implemetationPrivate methodIVsUIHierarchy.GetNestedHierarchyDetermines whether or not a node is a nested hierarchy.
Explicit interface implemetationPrivate methodIVsUIHierarchy.GetPropertyGets the value of a property for a given node.
Explicit interface implemetationPrivate methodIVsUIHierarchy.GetSiteGets the service provider from which to access the services.
Explicit interface implemetationPrivate methodIVsUIHierarchy.ParseCanonicalNameReturns the identifier of the hierarchy item, given its canonical name.
Explicit interface implemetationPrivate methodIVsUIHierarchy.QueryCloseDetermines whether the hierarchy can be closed.
Explicit interface implemetationPrivate methodIVsUIHierarchy.QueryStatusCommandGets the status of the specified commands.
Explicit interface implemetationPrivate methodIVsUIHierarchy.SetGuidPropertySets properties whose values are GUIDs.
Explicit interface implemetationPrivate methodIVsUIHierarchy.SetPropertySets properties of a specific node or of the hierarchy.
Explicit interface implemetationPrivate methodIVsUIHierarchy.SetSiteSets the service provider from which to access the services.
Explicit interface implemetationPrivate methodIVsUIHierarchy.UnadviseHierarchyEventsDisables client notification of hierarchy events.
Explicit interface implemetationPrivate methodIVsUIHierarchy.Unused0A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsUIHierarchy.Unused1A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsUIHierarchy.Unused2A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsUIHierarchy.Unused3A placeholder for a future method.
Explicit interface implemetationPrivate methodIVsUIHierarchy.Unused4A placeholder for a future method.
Top

For more information on flavored projects, see Project Subtypes.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft