FlavoredProjectFactoryBase Class

Article
2013-02-04

Base class for flavored project factories.

This API is not CLS-compliant.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Shell.Flavor.FlavoredProjectFactoryBase

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class FlavoredProjectFactoryBase _
    Implements IVsAggregatableProjectFactoryCorrected, IVsProjectFactory

[CLSCompliantAttribute(false)]
public abstract class FlavoredProjectFactoryBase : IVsAggregatableProjectFactoryCorrected, 
    IVsProjectFactory

[CLSCompliantAttribute(false)]
public ref class FlavoredProjectFactoryBase abstract : IVsAggregatableProjectFactoryCorrected, 
    IVsProjectFactory

[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type FlavoredProjectFactoryBase =  
    class
        interface IVsAggregatableProjectFactoryCorrected
        interface IVsProjectFactory
    end

public abstract class FlavoredProjectFactoryBase implements IVsAggregatableProjectFactoryCorrected, IVsProjectFactory

The FlavoredProjectFactoryBase type exposes the following members.

Constructors

	Name	Description
	FlavoredProjectFactoryBase	Initializes a new instance of FlavoredProjectFactoryBase.

Top

Properties

	Name	Description
	serviceProvider	Gets the project's service provider.

Top

Methods

	Name	Description
	CanCreateProject	Determines whether or not the project can be created with the supplied parameters.
	CreateProject	Creates a project.
	Dispose	Disposes the service provider.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	Initializes the project factory.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PreCreateForOuter	Creates an instance of the project.
	ProjectTypeGuids	Gets the set of project type GUIDs from the project file.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IVsAggregatableProjectFactoryCorrected.GetAggregateProjectType
	IVsAggregatableProjectFactoryCorrected.PreCreateForOuter
	IVsProjectFactory.CanCreateProject
	IVsProjectFactory.Close
	IVsProjectFactory.CreateProject
	IVsProjectFactory.SetSite

Top

Remarks

An implementation of a flavored project factory is defined by FlavoredProjectFactory. Override the PreCreateForOuter method to return a new FlavoredProjectBase derived class. The derived class GetGuidProperty method can redirect the templates search to find new project templates for this flavor.

Examples

namespace Microsoft.Samples.VisualStudio.IronPythonProject.WPFProviders
{
    [ComVisible(true)]
    [ClassInterface(ClassInterfaceType.None)]
    [Guid("FEBF49B8-D18C-4745-ADE0-35BF632E0533")]
    public class PythonWPFFlavor : FlavoredProjectBase
    {
        public PythonWPFFlavor(IServiceProvider site)
        {
            this.serviceProvider = site;
        }

        protected override Guid GetGuidProperty(uint itemId, int propId)
        {
            if (propId == 
                (int)__VSHPROPID2.VSHPROPID_AddItemTemplatesGuid)
            {
                return typeof(PythonWPFProjectFactory).GUID;
            }
            return base.GetGuidProperty(itemId, propId);
        }

        protected override int GetProperty(uint itemId, int propId, out object property)
        {
            return base.GetProperty(itemId, propId, out property);
        }
    }
    [Guid(PythonWPFProjectFactory.PythonWPFProjectFactoryGuid)]
    public class PythonWPFProjectFactory : FlavoredProjectFactoryBase
    {
        public const string PythonWPFProjectFactoryGuid = "229B3E77-97E9-4f6d-9151-E6D103EA4D4A";

        private IServiceProvider site;
        public PythonWPFProjectFactory(IServiceProvider site) : base()
        {
            this.site = site;
        }

        protected override object PreCreateForOuter(IntPtr outerProjectIUnknown)
        {
            return new PythonWPFFlavor(site);
        }
    }
}

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.

Share via