共用方式為

ITextTemplatingEngineHost.LoadIncludeText 方法

  • 發行項

取得對應至要求以包含部分文字範本檔案的文字。

命名空間：  Microsoft.VisualStudio.TextTemplating
組件：  Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (在 Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll 中)

語法

'宣告
Function LoadIncludeText ( _
    requestFileName As String, _
    <OutAttribute> ByRef content As String, _
    <OutAttribute> ByRef location As String _
) As Boolean

bool LoadIncludeText(
    string requestFileName,
    out string content,
    out string location
)

bool LoadIncludeText(
    String^ requestFileName, 
    [OutAttribute] String^% content, 
    [OutAttribute] String^% location
)

abstract LoadIncludeText : 
        requestFileName:string * 
        content:string byref * 
        location:string byref -> bool 

function LoadIncludeText(
    requestFileName : String, 
    content : String, 
    location : String
) : boolean

參數

  • requestFileName
    型別：System.String
    要取得之部分文字範本檔案的名稱。
  • location
    型別：System.String%
    String ，包含取得之文字的位置。如果主應用程式搜尋登錄以尋找 Include 檔案的位置，或是根據預設搜尋多個位置，則主應用程式會傳回這個參數中 Include 檔案的最後路徑。如果找不到檔案，或者主應用程式不是以檔案系統為基礎，則主應用程式可以將 location 設定為 Empty。

傳回值

型別：System.Boolean
true 表示主應用程式是否能夠取得文字，否則為 false。

備註

如果使用者已經在文字範本中指定了選擇性的 include 指示詞，引擎便會呼叫這個方法。每個轉換可呼叫這個方法 0 次、1 次或多次。如需詳細資訊，請參閱 T4 文字範本指示詞。

這個方法也可以從自訂的指示詞處理器來呼叫。

範例

下列程式碼範例示範自訂主機可能的實作。這個程式碼是完整範例的一部分。如需完整的範例，請參閱 逐步解說：建立自訂文字範本主機。

public bool LoadIncludeText(string requestFileName, out string content, out string location)
{
    content = System.String.Empty;
    location = System.String.Empty;
    
    //If the argument is the fully qualified path of an existing file,
    //then we are done.
    //----------------------------------------------------------------
    if (File.Exists(requestFileName))
    {
        content = File.ReadAllText(requestFileName);
        return true;
    }

    //This can be customized to search specific paths for the file.
    //This can be customized to accept paths to search as command line
    //arguments.
    //----------------------------------------------------------------
    else
    {
        return false;
    }
}

Public Function LoadIncludeText(ByVal requestFileName As String, ByRef content As String, ByRef location As String) As Boolean Implements ITextTemplatingEngineHost.LoadIncludeText

    content = System.String.Empty
    location = System.String.Empty

    'If the argument is the fully qualified path of an existing file,
    'then we are done.
    '----------------------------------------------------------------
    If File.Exists(requestFileName) Then

        content = File.ReadAllText(requestFileName)
        Return True

    'This can be customized to search specific paths for the file.
    'This can be customized to accept paths to search as command line
    'arguments.
    '----------------------------------------------------------------
    Else
        Return False
    End If
End Function

.NET Framework 安全性

請參閱

參考

ITextTemplatingEngineHost 介面

Microsoft.VisualStudio.TextTemplating 命名空間

其他資源

逐步解說：建立自訂文字範本主機