VCFilter Interface

A VCFilter object exposes the functionality on a folder in Solution Explorer for a Visual C++ project.

Namespace:  Microsoft.VisualStudio.VCProjectEngine
Assembly:  Microsoft.VisualStudio.VCProjectEngine (in Microsoft.VisualStudio.VCProjectEngine.dll)

Syntax

'Declaration
<GuidAttribute("3EEA69D5-3A07-426F-8969-0A9FFC45A1FC")> _
Public Interface VCFilter _
    Inherits VCProjectItem
[GuidAttribute("3EEA69D5-3A07-426F-8969-0A9FFC45A1FC")]
public interface VCFilter : VCProjectItem
[GuidAttribute(L"3EEA69D5-3A07-426F-8969-0A9FFC45A1FC")]
public interface class VCFilter : VCProjectItem
[<GuidAttribute("3EEA69D5-3A07-426F-8969-0A9FFC45A1FC")>]
type VCFilter =  
    interface 
        interface VCProjectItem 
    end
public interface VCFilter extends VCProjectItem

The VCFilter type exposes the following members.

Properties

  Name Description
Public property CanonicalName Gets the unique name used for this filter.
Public property Files Gets the collection of files associated with the filter.
Public property Filter Gets or sets a list of the file extensions associated with the filter.
Public property Filters Gets the collection of filters for the filter.
Public property ItemName Gets the name of the current item in the collection.
Public property Items Gets the collection of filters associated with the project.
Public property Kind Returns an enumeration indicating the type of filter.
Public property Name Gets or sets the name of the filter.
Public property Object Provides a reference between the Visual Studio object model and the Visual C++ object model.
Public property Parent Returns the immediate parent object of a given object.
Public property ParseFiles Gets or sets a value indicating whether the files in a filter are open to inspection by IntelliSense.
Public property project Gets the VCProject associated with the filter.
Public property SourceControlFiles Gets or sets a value indicating whether files added to the filter are automatically placed under source code control.
Public property UniqueIdentifier Specifies a nonlocalizable name for the filter.
Public property UrlBehavior Gets a value indicating whether the URL of a Web reference is hard-coded in the generated Visual Basic or Visual C# proxy code. This property is meaningful only for filters that have Web references.
Public property VCProjectEngine Gets a pointer to the project engine.
Public property WebReference Gets the URL of the Web reference for the filter.

Top

Methods

  Name Description
Public method AddFile Adds a file to the current filter.
Public method AddFilter Adds a new filter to the current group of filters.
Public method AddWebReference Adds a reference to a Web service to the filter. A new Web service reference subfolder is added to the Web References folder of the project. This new folder contains several other project items related to the Web service. The method returns the ProjectItem object associated with the new Web service folder.
Public method CanAddFile Returns true if the specified file can be added to the current filter.
Public method CanAddFilter Returns true if the specified filter can be added as a top-level filter or as a subfilter to the current filter.
Public method CanMove Returns true if the filter can be moved to the specified location.
Public method MatchName Matches a specified name to the name of a collection item.
Public method Move Moves a file or folder into the top level of the project or a new folder.
Public method Remove Removes the specified filter from the project.
Public method RemoveFile Removes a file from the current filter.
Public method RemoveFilter Removes a filter from the current project.

Top

See Also

Reference

Microsoft.VisualStudio.VCProjectEngine Namespace