DirectiveProcessor.IsDirectiveSupported メソッド

[アーティクル]
08/09/2011

派生クラスでオーバーライドされると、ディレクティブプロセッサが指定されたディレクティブをサポートするかどうかを確認します。

名前空間: Microsoft.VisualStudio.TextTemplating
アセンブリ: Microsoft.VisualStudio.TextTemplating.10.0 (Microsoft.VisualStudio.TextTemplating.10.0.dll 内)

構文

'宣言
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

パラメーター

directiveName
型: System.String
ディレクティブの名前。

戻り値

型: System.Boolean
ディレクティブがプロセッサでサポートされている場合は true。それ以外の場合は false。

解説

1 つのディレクティブプロセッサで、多くの異なるディレクティブをサポートできます。

現在、IsDirectiveSupported を呼び出しても、ディレクティブプロセッサのステートマシンには影響しません。これは、このメソッドから false を返す場合は、他のメソッドが呼び出されることを意味します。理想的には、ディレクティブがサポートされていない場合は、ステートマシンを終了する必要があります。将来的には、このメソッドが false を返すと終了するように、エンジンが変更される可能性があります。

例

カスタムディレクティブプロセッサを実装するコード例を次に示します。次のコード例は、DirectiveProcessor クラス用のより大きなコード例の一部です。

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