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.
Inheritance Hierarchy
Object
Microsoft.VisualStudio.ProjectAggregator.CProjectAggregatorClass
Microsoft.VisualStudio.Shell.Flavor.FlavoredProject
Namespace: Microsoft.VisualStudio.Shell.Flavor
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
Public MustInherit Class FlavoredProject _
Inherits CProjectAggregatorClass _
Implements IVsAggregatableProject, IServiceProvider, IVsHierarchy, IVsUIHierarchy, _
IOleCommandTarget, IVsTrackProjectDocumentsEvents2
public abstract class FlavoredProject : CProjectAggregatorClass,
IVsAggregatableProject, IServiceProvider, IVsHierarchy, IVsUIHierarchy, IOleCommandTarget,
IVsTrackProjectDocumentsEvents2
public ref class FlavoredProject abstract : public CProjectAggregatorClass,
IVsAggregatableProject, IServiceProvider, IVsHierarchy, IVsUIHierarchy, IOleCommandTarget,
IVsTrackProjectDocumentsEvents2
[<AbstractClass>]
type FlavoredProject =
class
inherit CProjectAggregatorClass
interface IVsAggregatableProject
interface IServiceProvider
interface IVsHierarchy
interface IVsUIHierarchy
interface IOleCommandTarget
interface IVsTrackProjectDocumentsEvents2
end
public abstract class FlavoredProject extends CProjectAggregatorClass implements IVsAggregatableProject, IServiceProvider, IVsHierarchy, IVsUIHierarchy, IOleCommandTarget, IVsTrackProjectDocumentsEvents2
The FlavoredProject type exposes the following members.
Constructors
Name | Description | |
---|---|---|
FlavoredProject | When overridden in a derived class, initializes an instance of the FlavoredProject class. |
Top
Methods
Name | Description | |
---|---|---|
AdviseHierarchyEvents | Subscribes to hierarchy events. | |
Close | Closes and cleans up a hierarchy once the environment determines that it is no longer used. | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
ExecCommand | Executes a command on a specific item within a UI hierarchy window, or on the hierarchy itself. | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetCanonicalName | Gets the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions. | |
GetGuidProperty | Gets properties whose values are GUIDs. | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetNestedHierarchy | Determines whether or not a node is a nested hierarchy. | |
GetProperty | Gets the value of a property for a given node. | |
GetSite | Gets the service provider from which to access the services. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
InitializeForOuter | Called by the outer project subtype to have the owned inner project subtype do its initialization work. | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnAggregationComplete | Subscribes to IVsTrackProjectDocumentsEvents2 events. It is not required to flavor a project but makes it easier for derived classes to subscribe to these events. | |
ParseCanonicalName | Returns the identifier of the hierarchy item, given its canonical name. | |
QueryClose | Determines whether the hierarchy can be closed. | |
QueryStatusCommand | Gets the status of the specified commands. | |
SetGuidProperty | Sets properties whose values are GUIDs. | |
SetInner | Sets the inner project. (Inherited from CProjectAggregatorClass.) | |
SetInnerProject | Sets up the interfaces and menu commands for the inner project. | |
SetProperty | Sets properties of a specific node or of the hierarchy. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
UnadviseHierarchyEvents | Disables client notification of hierarchy events. | |
Unused0 | A placeholder for a future method. | |
Unused1 | A placeholder for a future method. | |
Unused2 | A placeholder for a future method. | |
Unused3 | A placeholder for a future method. | |
Unused4 | A placeholder for a future method. |
Top
Events
Name | Description | |
---|---|---|
DirectoryAdded | Raised after a directory has been added to the project. | |
DirectoryRemoved | Raised after a directory has been removed from the project. | |
DirectoryRenamed | Raised after a directory in the project has been renamed. | |
FileAdded | Raised after a file has been added to the project. | |
FileRemoved | Raised after a file has been removed from the project. | |
FileRenamed | Raised after a file in the project has been renamed. | |
SccStatusChanged | Raised after the source code control status of an item in the project has changed. |
Top
Extension Methods
Name | Description | |
---|---|---|
IsCapabilityMatch | Checks whether a given project matches the requirements prescribed in an AppliesTo expression. (Defined by PackageUtilities.) |
Top
Fields
Name | Description | |
---|---|---|
innerOleCommandTarget | The IOleCommandTarget interface of the inner project. | |
innerVsAggregatableProject | The IVsAggregatableProject of the inner project. | |
innerVsHierarchy | The IVsHierarchy interface of the inner project. | |
innerVsUIHierarchy | The IVsUIHierarchy interface of the inner project. | |
serviceProvider | The service provider of the project. |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IServiceProvider.GetService | Gets the service of the specified type. | |
IOleCommandTarget.Exec | Executes a specified command or displays help for a command. | |
IOleCommandTarget.QueryStatus | Queries the object for the status of one or more commands. | |
IVsAggregatableProject.GetAggregateProjectTypeGuids | 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. | |
IVsAggregatableProject.InitializeForOuter | Called by the outer project subtype to have the inner project subtype do its initialization work. | |
IVsAggregatableProject.OnAggregationComplete | Called to continue initialization after aggregation is complete. | |
IVsAggregatableProject.SetAggregateProjectTypeGuids | Updates the list of GUIDs that are persisted in the project file of the base project. | |
IVsAggregatableProject.SetInnerProject | Sets up the inner project as well as the necessary interface pointers. | |
IVsHierarchy.AdviseHierarchyEvents | Subscribes to hierarchy events. | |
IVsHierarchy.Close | Closes and cleans up a hierarchy once the environment determines that it is no longer used. | |
IVsHierarchy.GetCanonicalName | Gets a unique name for an item in the hierarchy. Used for workspace persistence, such as remembering window positions. | |
IVsHierarchy.GetGuidProperty | Gets properties whose values are GUIDs. | |
IVsHierarchy.GetNestedHierarchy | Determines whether or not a node is a nested hierarchy. | |
IVsHierarchy.GetProperty | Gets properties of a given node or of the hierarchy. | |
IVsHierarchy.GetSite | Gets the service provider from which to access the services. | |
IVsHierarchy.ParseCanonicalName | Returns the identifier of the hierarchy item, given its canonical name. | |
IVsHierarchy.QueryClose | Determines whether the hierarchy can be closed. | |
IVsHierarchy.SetGuidProperty | Sets properties whose values are GUIDs. | |
IVsHierarchy.SetProperty | Sets properties of a specific node or of the hierarchy. | |
IVsHierarchy.SetSite | Sets the service provider from which to access the services. | |
IVsHierarchy.UnadviseHierarchyEvents | Disables client notification of hierarchy events. | |
IVsHierarchy.Unused0 | A placeholder for a future method. | |
IVsHierarchy.Unused1 | A placeholder for a future method. | |
IVsHierarchy.Unused2 | A placeholder for a future method. | |
IVsHierarchy.Unused3 | A placeholder for a future method. | |
IVsHierarchy.Unused4 | A placeholder for a future method. | |
IVsTrackProjectDocumentsEvents2.OnAfterAddDirectoriesEx | Raised after directories have been added to a project. | |
IVsTrackProjectDocumentsEvents2.OnAfterAddFilesEx | Raised after files have been added to a project. | |
IVsTrackProjectDocumentsEvents2.OnAfterRemoveDirectories | Raised after a directory was removed from the project. | |
IVsTrackProjectDocumentsEvents2.OnAfterRemoveFiles | Raised after files have been removed from the project. | |
IVsTrackProjectDocumentsEvents2.OnAfterRenameDirectories | Raised after a directory has been moved or renamed. | |
IVsTrackProjectDocumentsEvents2.OnAfterRenameFiles | Raised after files have been moved or renamed. | |
IVsTrackProjectDocumentsEvents2.OnAfterSccStatusChanged | This method is called by the source code control component to inform listeners that source control status has changed. Do not call this method. | |
IVsTrackProjectDocumentsEvents2.OnQueryAddDirectories | Raised by a project to determine whether directories can be added to the project. Not used. | |
IVsTrackProjectDocumentsEvents2.OnQueryAddFiles | Raised to determine whether files can be added to the project. Not used. | |
IVsTrackProjectDocumentsEvents2.OnQueryRemoveDirectories | Raised to determine whether directories can be removed from the project. Not used. | |
IVsTrackProjectDocumentsEvents2.OnQueryRemoveFiles | Raised to determine whether files can be removed from the project. Not used. | |
IVsTrackProjectDocumentsEvents2.OnQueryRenameDirectories | Raised to determine whether directories can be renamed in the project. Not used. | |
IVsTrackProjectDocumentsEvents2.OnQueryRenameFiles | Raised to determine whether files can be renamed in the project. Not used. | |
IVsUIHierarchy.AdviseHierarchyEvents | Subscribes to hierarchy events. | |
IVsUIHierarchy.Close | Closes the project and cleans up its resources once the environment determines that it is no longer used. | |
IVsUIHierarchy.ExecCommand | Executes a command on a specific item within a UI hierarchy window, or on the hierarchy itself. | |
IVsUIHierarchy.GetCanonicalName | Gets the unique name associated with an item in the hierarchy. Used for workspace persistence, such as remembering window positions. | |
IVsUIHierarchy.GetGuidProperty | Gets properties whose values are GUIDs. | |
IVsUIHierarchy.GetNestedHierarchy | Determines whether or not a node is a nested hierarchy. | |
IVsUIHierarchy.GetProperty | Gets the value of a property for a given node. | |
IVsUIHierarchy.GetSite | Gets the service provider from which to access the services. | |
IVsUIHierarchy.ParseCanonicalName | Returns the identifier of the hierarchy item, given its canonical name. | |
IVsUIHierarchy.QueryClose | Determines whether the hierarchy can be closed. | |
IVsUIHierarchy.QueryStatusCommand | Gets the status of the specified commands. | |
IVsUIHierarchy.SetGuidProperty | Sets properties whose values are GUIDs. | |
IVsUIHierarchy.SetProperty | Sets properties of a specific node or of the hierarchy. | |
IVsUIHierarchy.SetSite | Sets the service provider from which to access the services. | |
IVsUIHierarchy.UnadviseHierarchyEvents | Disables client notification of hierarchy events. | |
IVsUIHierarchy.Unused0 | A placeholder for a future method. | |
IVsUIHierarchy.Unused1 | A placeholder for a future method. | |
IVsUIHierarchy.Unused2 | A placeholder for a future method. | |
IVsUIHierarchy.Unused3 | A placeholder for a future method. | |
IVsUIHierarchy.Unused4 | A placeholder for a future method. |
Top
Remarks
For more information on flavored projects, see Project Subtypes.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.