VCFilter.CanAddFilter Method

Article
10/10/2013

Returns true if the specified filter can be added as a top-level filter or as a subfilter to the current filter.

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

Syntax

'Declaration
Function CanAddFilter ( _
    Filter As String _
) As Boolean

bool CanAddFilter(
    string Filter
)

bool CanAddFilter(
    [InAttribute] String^ Filter
)

abstract CanAddFilter : 
        Filter:string -> bool

function CanAddFilter(
    Filter : String
) : boolean

Parameters

Filter
Type: System.String

Required. The new filter to be added. The filter name must be unique within the current scope and valid.

Return Value

Type: System.Boolean
true if the filter can be added; otherwise false.

Remarks

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

Examples

The following example uses CanAddFilter 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 mycollection As IVCCollection
        Dim filter As VCFilter
        Dim prj As VCProject
        Dim ret As Boolean
        prj = DTE.Solution.Projects.Item(1).Object
        mycollection = prj.Filters
        'mycollection.Count has count of files
        filter = mycollection.Item(1)
        MsgBox(filter.ItemName)
        ret = filter.CanAddFilter("somename")
        MsgBox(ret)
    End Sub
End Module

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via