共用方式為


Format-Custom

使用自定義檢視來格式化輸出。

語法

Default (預設值)

Format-Custom
    [[-Property] <Object[]>]
    [-Depth <Int32>]
    [-GroupBy <Object>]
    [-View <String>]
    [-ShowError]
    [-DisplayError]
    [-Force]
    [-Expand <String>]
    [-InputObject <PSObject>]
    [<CommonParameters>]

Description

Format-Custom cmdlet 會將命令的輸出格式化為在替代檢視中所定義的格式。 Format-Custom 的設計目的是顯示不僅限於表格或清單的視圖。 您可以使用以 *格式定義的檢視。PowerShell 目錄中的 PS1XML 檔案,或者您可以在新的 PS1XML 檔案中建立自己的檢視,並使用 Update-FormatData Cmdlet 將它們新增至 PowerShell。

範例

範例 1:使用自定義檢視格式化輸出

Get-Command Start-Transcript | Format-Custom -View MyView

此命令會將 Start-Transcript Cmdlet 的相關信息格式化為 MyView 檢視所定義的格式,這是使用者所建立的自定義檢視。 若要成功執行此命令,您必須先建立新的 PS1XML 檔案、定義 MyView 檢視,然後使用 Update-FormatData 命令將 PS1XML 檔案新增至 PowerShell。

範例 2:使用預設檢視格式化輸出

Get-Process Winlogon | Format-Custom

此命令會將 Winlogon 程式的相關信息格式化為替代自定義檢視。 因為命令不使用 View 參數,Format-Custom 使用預設自定義檢視來格式化數據。

範例 3:格式錯誤的疑難排解

下列範例顯示使用表示式新增 DisplayErrorShowError 參數的結果。

PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -DisplayError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  = #ERR
}


PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  =
}

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 8:01:04 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

參數

-Depth

指定顯示中的數據行數目。

參數屬性

類型:Int32
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DisplayError

在指令行上顯示錯誤。 這個參數很少使用,但是當您在 Format-Custom 命令中格式化表達式時,可以用來做為偵錯輔助,而且表達式似乎無法運作。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Expand

對集合物件以及集合中的物件進行格式化。 此參數的設計目的是要格式化支援 ICollection (System.Collections) 介面的物件。 預設值為 EnumOnly

有效值為:

  • EnumOnly:顯示集合中對象的屬性。
  • CoreOnly:顯示集合對象的屬性。
  • 兩者:顯示集合對象的屬性和集合中對象的屬性。

參數屬性

類型:String
預設值:EnumOnly
接受的值:CoreOnly, EnumOnly, Both
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Force

指示 Cmdlet 顯示所有錯誤資訊。 搭配 DisplayErrorShowError 參數使用。 預設情況下,當錯誤物件被寫入錯誤流或顯示流時,僅顯示部分錯誤資訊。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-GroupBy

根據共用屬性或值,將輸出格式化為群組。 輸入輸出的表達式或屬性。

GroupBy 參數的值可以是新的導出屬性。 若要建立導出的屬性,請使用哈希表。 有效的金鑰如下:

  • 名稱 (或標籤) <字串>
  • 表達式 <字串> 或 <腳本區塊>
  • FormatString <字串>

參數屬性

類型:Object
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-InputObject

指定要格式化的物件。 輸入包含 物件的變數,或輸入取得物件的命令或表達式。

參數屬性

類型:PSObject
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Property

指定顯示在顯示中的物件屬性,以及它們出現的順序。 允許使用通配符。

如果您省略此參數,顯示中顯示的屬性取決於所顯示的物件。 參數名稱 (“Property”) 是選擇性的。 您不能在相同的命令中使用 屬性檢視 參數。

Property 參數的值可以是新的導出屬性。 若要建立導出屬性,請使用哈希表。 有效的金鑰如下:

  • 表達式 <字串> 或 <腳本區塊>
  • 深度 <int32>

參數屬性

類型:

Object[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

(All)
Position:0
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ShowError

透過管線傳遞錯誤訊息。 這個參數很少使用,但是當您在 Format-Custom 命令中格式化表達式時,可以用來做為偵錯輔助,而且表達式似乎無法運作。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-View

指定替代格式或「檢視」的名稱。如果您省略此參數,Format-Custom 會使用預設自定義檢視。 您不能在相同的命令中使用 屬性檢視 參數。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters

輸入

PSObject

您可以使用管線將任何物件傳送至 Format-Custom。

輸出

Microsoft.PowerShell.Commands.Internal.Format

Format-Custom 會傳回代表顯示的格式物件。

備註

Format-Custom 的設計目的是顯示不僅限於表格或清單的視圖。 若要顯示替代資料表檢視,請使用 Format-Table。 若要顯示替代清單檢視,請使用 Format-List

您也可以透過內建別名 「fc」 來參考 Format-Custom。 如需詳細資訊,請參閱 about_Aliases

GroupBy 參數會假設物件已排序。 使用 Format-Custom 來群組物件之前,請使用 Sort-Object 加以排序。