VCFilter.Filter Property

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.dll

Package:: Microsoft.VisualStudio.VCProjectEngine v17.11.40252

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a list of the file extensions associated with the filter.

public:
 property System::String ^ Filter { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ Filter { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(2341)]
public string Filter { [System.Runtime.InteropServices.DispId(2341)] get; [System.Runtime.InteropServices.DispId(2341)] set; }

[<System.Runtime.InteropServices.DispId(2341)>]
[<get: System.Runtime.InteropServices.DispId(2341)>]
[<set: System.Runtime.InteropServices.DispId(2341)>]
member this.Filter : string with get, set

Public Property Filter As String

Property Value

String

A string representing the list of file extensions for the filter.

Attributes: DispIdAttribute

Examples

The following example uses Filter in the integrated development environment (IDE):

' Macro code.  
' add reference to Microsoft.VisualStudio.VCProjectEngine  
Imports EnvDTE  
Imports Microsoft.VisualStudio.VCProjectEngine  

Public Module Module1  
    Sub Test()  
        Dim idx As Integer  
        Dim filter As VCFilter  
        Dim col As IVCCollection  
        Dim prj As VCProject  
        prj = DTE.Solution.Projects.Item(1).Object  
        col = prj.Filters  
        For idx = 1 To col.Count  
            filter = col.Item(idx)  
            MsgBox(filter.Filter)  
            filter.Filter = ".cpp;.cxx;.c"  
            MsgBox(filter.Filter)  
        Next  
    End Sub  
End Module

Remarks

See AddFile for more information.

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

Applies to

Share via