ExpansionProvider.IsValidKind Method

Determines whether this is valid text for expansion. This method should be overridden if you want to specify where in the source document the expansion can take place.

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
Public Overridable Function IsValidKind ( _
    buffer As IVsTextLines, _
    ts As TextSpan(), _
    bstrKind As String, _
    <OutAttribute> ByRef fIsValid As Integer _
) As Integer

'Usage
Dim instance As ExpansionProvider 
Dim buffer As IVsTextLines 
Dim ts As TextSpan()
Dim bstrKind As String 
Dim fIsValid As Integer 
Dim returnValue As Integer 

returnValue = instance.IsValidKind(buffer, _
    ts, bstrKind, fIsValid)

public virtual int IsValidKind(
    IVsTextLines buffer,
    TextSpan[] ts,
    string bstrKind,
    out int fIsValid
)

public:
virtual int IsValidKind(
    IVsTextLines^ buffer, 
    array<TextSpan>^ ts, 
    String^ bstrKind, 
    [OutAttribute] int% fIsValid
)

public function IsValidKind(
    buffer : IVsTextLines, 
    ts : TextSpan[], 
    bstrKind : String, 
    fIsValid : int
) : int

Parameters

buffer
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextLines

The IVsTextLines buffer.

ts
Type: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]

An array of TextSpan objects.

bstrKind
Type: System.String

The kind of expansion to perform.

fIsValid
Type: System.Int32%

[out] Returns true if it is a valid expansion kind, otherwise false.

Return Value

Type: System.Int32
When overridden in derived classes, S_OK if the method succeeds, otherwise an error code.

Implements

IVsExpansionClient.IsValidKind(IVsTextLines, array<TextSpan[], String, Int32%)

Remarks

This method by default checks only that buffer is the same as the IVsTextLines of Source; it will throw an ArgumentException if not. Implementers must override this method if they wish to specify where in a document a given expansion can be performed.

.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.