Format-Wide

オブジェクトを、各オブジェクトのプロパティを 1 つだけ表示する幅広い表として書式設定します。

構文

Format-Wide [[-Property] <Object>] [-AutoSize] [-Column <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]

説明

Format-Wide コマンドレットは、各オブジェクトのプロパティを 1 つだけ表示する幅広い表としてオブジェクトを書式設定します。Property パラメーターを使用すると、表示するプロパティを指定できます。

パラメーター

-AutoSize

データの幅に応じて、列のサイズと数を調整します。既定では、列のサイズと数はビューによって決まります。同じコマンド内で AutoSize パラメーターと Column パラメーターを使用することはできません。

-Column <int>

表示する列の数を指定します。同じコマンド内で AutoSize パラメーターと Column パラメーターを使用することはできません。

-DisplayError

エラーをコマンド ラインに表示します。

-Expand <string>

コレクション オブジェクトおよびコレクション内のオブジェクトを書式設定します。このパラメーターは、ICollection (System.Collections) インターフェイスをサポートするオブジェクトを書式設定するために用意されました。既定値は EnumOnly です。

有効な値は次のとおりです。

-- EnumOnly: コレクション内のオブジェクトのプロパティを表示します。

-- CoreOnly: コレクション オブジェクトのプロパティを表示します。

-- Both: コレクション オブジェクトのプロパティおよびコレクション内のオブジェクトのプロパティを表示します。

-Force

セキュリティが低下しない限り、このコマンドの正常な実行を妨げる制限を無効にします。たとえば、Force を指定すると、読み取り専用属性が無効になるか、ファイル パスを完成させるためにディレクトリが作成されますが、ファイルのアクセス許可は変更されません。

-GroupBy <Object>

共有プロパティまたは値を基にグループ化した単位で出力の書式設定を行います。出力の式またはプロパティを入力します。

GroupBy パラメーターの値には、新しい集計プロパティを指定できます。集計プロパティを作成するには、ハッシュ テーブルを使用します。有効なキーは次のとおりです。

-- Name (または Label) <string>

-- Expression <string> または <script block>

-- FormatString <string>

-InputObject <psobject>

書式設定するオブジェクトを指定します。オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。

-Property <Object>

表示するオブジェクト プロパティとその表示順序を指定します。ワイルドカードを使用できます。

このパラメーターを省略した場合、表示されるプロパティが、表示されるオブジェクトごとに異なります。パラメーター名 ("Property") はオプションです。同じコマンド内で Property パラメーターと View パラメーターを使用することはできません。

Property パラメーターの値には、新しい集計プロパティを指定できます。集計プロパティを作成するには、ハッシュ テーブルを使用します。有効なキーは次のとおりです。

-- Expression <string> または <script block>

-- FormatString <string>

-ShowError

パイプラインを介してエラーを送ります。

-View <string>

代替表形式の名前または "view" と指定します。同じコマンド内で Property パラメーターと View パラメーターを使用することはできません。

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

注

Format-Wide は、その組み込みエイリアスである "fw" で参照することもできます。詳細については、「about_Aliases」を参照してください。

GroupBy パラメーターは、オブジェクトの並べ替えが済んでいることを前提としています。Format-Custom でグループ化する前に、Sort-Object を使用してオブジェクトを並べ替えます。

-View パラメーターを使用すると、表の代替形式を指定できます。Windows PowerShell ディレクトリの *.format.PS1XML ファイルで定義されているビューを使用できるほか、新しい PS1XML ファイルに作成した独自のビューを Update-FormatData コマンドレットを使って Windows PowerShell に追加することも可能です。

View パラメーターに指定する代替ビューは、表形式でなければなりません。表形式でない場合、コマンドは失敗します。代替ビューが一覧の場合は、Format-List を使用します。代替ビューが一覧と表のどちらでもない場合は、Format-Custom を使用します。

例 1

C:\PS>get-childitem | format-wide -column 3

説明
-----------
このコマンドは、現在のディレクトリにあるファイルの名前を画面上 3 列で表示します。Get-ChildItem コマンドレットは、ディレクトリにある各ファイルを表すオブジェクトを取得します。パイプライン経由でファイル オブジェクトは、パイプライン演算子 (|) によって Format-Wide に渡され、出力用に書式設定されます。Column パラメーターによって、列数が決まります。

例 2

C:\PS>get-childitem HKCU:\software\microsoft | format-wide -property pschildname -autosize

説明
-----------
このコマンドは、HKEY_CURRENT_USER\Software\Microsoft キーにあるレジストリ キーの名前を表示します。Get-ChildItem コマンドレットは、キーを表すオブジェクトを取得します。パスは、HKCU: (Windows PowerShell レジストリ プロバイダーが公開するドライブの 1 つ) の後にキー パスを記述するという形式で指定します。レジストリ キー オブジェクトは、パイプライン演算子 (|) によりパイプラインを介して Format-Wide に渡され、出力用に書式設定されます。Property パラメーターによりプロパティの名前が指定され、AutoSize パラメーターにより列が読みやすくなるように調整されます。