DirectiveProcessor.IsDirectiveSupported-Methode

Artikel
07/20/2011

Bestimmt beim Überschreiben in einer abgeleiteten Klasse, ob der Direktivenprozessor die angegebene Direktive unterstützt.

Namespace: Microsoft.VisualStudio.TextTemplating
Assembly: Microsoft.VisualStudio.TextTemplating.10.0 (in Microsoft.VisualStudio.TextTemplating.10.0.dll)

Syntax

'Declaration
Public MustOverride Function IsDirectiveSupported ( _
    directiveName As String _
) As Boolean

public abstract bool IsDirectiveSupported(
    string directiveName
)

public:
virtual bool IsDirectiveSupported(
    String^ directiveName
) abstract

abstract IsDirectiveSupported : 
        directiveName:string -> bool

public abstract function IsDirectiveSupported(
    directiveName : String
) : boolean

Parameter

directiveName
Typ: System.String
Der Name der Direktive.

Rückgabewert

Typ: System.Boolean
true, wenn die Direktive vom Prozessor unterstützt wird, andernfalls false.

Hinweise

Ein Direktivenprozessor kann viele verschiedene Direktiven unterstützen.

Derzeit wirkt sich das Aufrufen von IsDirectiveSupported nicht auf den Zustandsautomaten des Direktivenprozessors aus. Dies bedeutet, falls von dieser Methode false zurückgegeben wird, werden andere Methoden immer noch aufgerufen. Falls eine Direktive nicht unterstützt wird, sollte der Zustandsautomat im Idealfall beendet werden. In der Zukunft wird das Modul möglicherweise so geändert, dass es beendet wird, wenn diese Methode false zurückgibt.

Beispiele

Im folgenden Codebeispiel wird eine mögliche Implementierung für einen benutzerdefinierten Direktivenprozessor veranschaulicht. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels, das für die DirectiveProcessor-Klasse bereitgestellt wird.

public override bool IsDirectiveSupported(string directiveName)
{
    if (string.Compare(directiveName, "CoolDirective", StringComparison.OrdinalIgnoreCase) == 0)
    {
        return true;
    }
    if (string.Compare(directiveName, "SuperCoolDirective", StringComparison.OrdinalIgnoreCase) == 0)
    {
        return true;
    }
    return false;
}

Public Overrides Function IsDirectiveSupported(ByVal directiveName As String) As Boolean

    If String.Compare(directiveName, "CoolDirective", StringComparison.OrdinalIgnoreCase) = 0 Then
        Return True
    End If

    If String.Compare(directiveName, "SuperCoolDirective", StringComparison.OrdinalIgnoreCase) = 0 Then
        Return True
    End If

    Return False
End Function

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.