ConvertTo-Html
Microsoft .NET Framework オブジェクトを Web ブラウザーで表示できる HTML に変換します。
構文
ConvertTo-Html [[-Head] <string[]>] [[-Title] <string>] [[-Body] <string[]>] [-CssUri <Uri>] [[-Property] <Object[]>] [-As <string>] [-InputObject <psobject>] [-PostContent <string[]>] [-PreContent <string[]>] [<CommonParameters>]
ConvertTo-Html [-Fragment] [[-Property] <Object[]>] [-As <string>] [-InputObject <psobject>] [-PostContent <string[]>] [-PreContent <string[]>] [<CommonParameters>]
説明
ConvertTo-Html コマンドレットは、.NET Framework オブジェクトを Web ブラウザーで表示できる HTML に変換します。このコマンドレットを使用すると、Web ページのコマンドの出力を表示できます。
ConvertTo-Html のパラメーターを使用すると、オブジェクト プロパティの選択、表形式または一覧形式の指定、HTML ページ タイトルの指定、オブジェクトの前後へのテキストの追加を行ったり、Strict DTD ページの代わりに表または一覧の断片のみを返すことができます。
複数のオブジェクトを ConvertTo-Html に送信すると、Windows PowerShell は、送信した最初のオブジェクトのプロパティに基づいて表 (または一覧) を作成します。指定されたプロパティのいずれかが残りのオブジェクトにない場合、そのオブジェクトのプロパティ値は空のセルになります。残りのオブジェクトに追加のプロパティがある場合、それらのプロパティ値はファイルに含まれません。
パラメーター
-As <string>
オブジェクトの書式設定が表形式と一覧形式のどちらであるかを決定します。有効な値は TABLE と LIST です。既定値は TABLE です。
TABLE の値は、Windows PowerShell の表形式に似た HTML の表を生成します。ヘッダー行にはプロパティ名が表示されます。表の各行はオブジェクトを表し、各プロパティのオブジェクトの値が表示されます。
LIST の値は、Windows PowerShell 一覧形式に似た 2 列の HTML の表をオブジェクトごとに生成します。最初の列にはプロパティ名、2 番目の列にはプロパティ値が表示されます。
必須 |
false |
位置 |
named |
既定値 |
Table |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Body <string[]>
<BODY> 開始タグの後に追加するテキストを指定します。既定では、この位置にテキストはありません。
必須 |
false |
位置 |
4 |
既定値 |
No text. |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CssUri <Uri>
HTML ファイルに適用されるカスケード スタイル シート (CSS) の URI (Uniform Resource Identifier) を指定します。URI は出力のスタイル シート リンクに含まれています。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Fragment
HTML の表のみを生成します。HTML、HEAD、TITLE、および BODY タグは省略されます。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Head <string[]>
<HEAD> タグの内容を指定します。既定値は "<title>HTML TABLE</title>" です。Head パラメーターを使用した場合、Title パラメーターは無視されます。
必須 |
false |
位置 |
2 |
既定値 |
<title>HTML TABLE</title> |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-InputObject <psobject>
HTML で表すブジェクトを指定します。オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。
このパラメーターを使用して複数のオブジェクト (たとえば、コンピューターで稼動しているすべてのサービス) を送信した場合は、オブジェクトのコレクションまたは配列 (System.Object[]) のプロパティを表示するテーブルが ConvertTo-Html によって作成されます。個々のオブジェクトの表を作成するには、パイプライン演算子を使用してオブジェクトを ConvertTo-Html にパイプします。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
true (ByValue) |
ワイルドカード文字を許可する |
false |
-PostContent <string[]>
</TABLE> 終了タグの後に追加するテキストを指定します。既定では、この位置にテキストはありません。
必須 |
false |
位置 |
named |
既定値 |
No text |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PreContent <string[]>
<TABLE> 開始タグの前に追加するテキストを指定します。既定では、この位置にテキストはありません。
必須 |
false |
位置 |
named |
既定値 |
No text |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Property <Object[]>
オブジェクトの指定したプロパティを HTML に含めます。
必須 |
false |
位置 |
1 |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Title <string>
HTML ファイルのタイトル、つまり <TITLE> タグで囲むテキストを指定します。
必須 |
false |
位置 |
3 |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
System.Management.Automation.PSObject パイプを使用してどの .NET オブジェクトでも ConvertTo-Html に渡すことができます。 |
出力 |
System.String ConvertTo-Html は、有効な HTML を構成する一連の文字列を返します。 |
注
このコマンドレットを使用するには、1 つ以上のオブジェクトをコマンドレットにパイプするか、InputObject パラメーターを使用してオブジェクトを指定します。入力が複数のオブジェクトで構成されていると、これら 2 つの方法の出力は大きく異なります。
-- 複数のオブジェクトをコマンドレットにパイプする場合は、オブジェクトが一度に 1 つずつコマンドレットに送信されます。その結果、ConvertTo-Html は個々のオブジェクトを表示する表を作成します。たとえば、コンピューター上のプロセスを ConvertTo-Html にパイプすると、作成された表にすべてのプロセスが表示されます。
-- InputObject パラメーターを使用して複数のオブジェクトを送信する場合、ConvertTo-Html はこれらのオブジェクトを 1 つのコレクションまたは配列として受信します。その結果、配列内の項目ではなく、配列とそのプロパティを表示する表が作成されます。たとえば、InputObject を使用してコンピューター上のプロセスを ConvertTo-Html に送信すると、表にはオブジェクトの配列 (System.Object[]) とそのプロパティが表示されます。
DOCTYPE タグは XHTML Strict DTD に従って変更されます。
(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">)
例 1
C:\PS>convertto-html -inputobject (get-date)
説明
-----------
このコマンドは、現在の日付のプロパティを表示する HTML ページを作成します。また InputObject パラメーターを使用して、Get-Date コマンドの結果を ConvertTo-Html コマンドレットに送信します。
例 2
C:\PS>get-alias | convertto-html > aliases.htm
C:\PS> invoke-item aliases.htm
説明
-----------
このコマンドは、現在のコンソールの Windows PowerShell エイリアスを一覧にする HTML ページを作成します。
このコマンドは、Get-Alias コマンドレットを使用してエイリアスを取得します。また、パイプライン演算子 (|) を使用してエイリアスを ConvertTo-Html コマンドレットに送信し、このコマンドレットが HTML ページを作成します。
例 3
C:\PS>get-eventlog -logname "Windows PowerShell | convertto-html > pslog.htm
説明
-----------
このコマンドは、ローカル コンピューターの Windows PowerShell イベント ログにイベントを表示する pslog.htm という HTML ページを作成します。
また、Get-EventLog コマンドレットを使用して Windows PowerShell ログのイベントを取得してから、パイプライン演算子 (|) を使用してイベントを ConvertTo-Html コマンドレットに送信します。
さらに、リダイレクト演算子 (>) を使用して、HTML コードを pslog.htm ファイルに送信します。
例 4
C:\PS>get-process | convertto-html -property Name, Path, Company -title "Process Information" > proc.htm; ii proc.htm
説明
-----------
これらのコマンドは、ローカル コンピューター上のプロセスの名前、パス、および会社を一覧にする HTML ページを作成して開きます。
最初のコマンドは、Get-Process コマンドレットを使用して、コンピューターで実行しているプロセスを表すオブジェクトを取得します。このコマンドは、パイプライン演算子 (|) を使用して、プロセス オブジェクトを ConvertTo-Html コマンドレットに送信します。
このコマンドは、Property パラメーターを使用して、表に含めるプロセス オブジェクトの 3 つのプロパティを選択します。このコマンドは、Title パラメーターを使用して HTML ページのタイトルを指定します。また、このコマンドは、リダイレクト演算子 (>) を使用して、結果の HTML を Proc.htm というファイルに送信します。
2 番目のコマンドは、Invoke-Item コマンドレット (エイリアスは ii) を使用して、既定のブラウザーで Proc.htm を開きます。2 つのコマンドは、セミコロン (;) で区切ります。
例 5
C:\PS>get-service | convertto-html -CssUri "test.css"
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>HTML TABLE</title>
<link rel="stylesheet" type="text/css" href="test.css" />
...
説明
-----------
このコマンドは、Get-Service コマンドレットが返すサービス オブジェクトの HTML ページを作成します。また、CssUri パラメーターを使用して HTML ページのカスケード スタイル シートを指定します。
CssUri パラメーターは結果の HTML に "<link rel="stylesheet" type="text/css" タグをもう 1 つ追加します。タグ内の HREF 属性にはスタイル シートの名前が含まれています。
例 6
C:\PS>get-service | convertto-html -as LIST > services.htm
説明
-----------
このコマンドは、Get-Service コマンドレットが返すサービス オブジェクトの HTML ページを作成します。また、As パラメーターを使用して一覧の形式を指定します。リダイレクト演算子 (>) は、結果の HTML を Services.htm ファイルに送信します。
例 7
C:\PS>get-date | cth -fragment
<table>
<colgroup>...</colgroup>
<tr><th>DisplayHint</th><th>DateTime</th><th>Date</th><th>Day</th><th>DayOfWeek</th><th>DayOfYear</th><th>Hour</th><th>
Kind</th><th>Millisecond</th><th>Minute</th><th>Month</th><th>Second</th><th>Ticks</th><th>TimeOfDay</th><th>Year</th><
/tr>
<tr><td>DateTime</td><td>Monday, May 05, 2008 10:40:04 AM</td><td>5/5/2008 12:00:00 AM</td><td>5</td><td>Monday</td><td
>126</td><td>10</td><td>Local</td><td>123</td><td>40</td><td>5</td><td>4</td><td>633455808041237213</td><td>10:40:04.12
37213</td><td>2008</td></tr>
</table>
説明
-----------
このコマンドは、ConvertTo-Html を使用して、現在の日付の HTML の表を生成します。また、Get-Date コマンドレットを使用して現在の日付を取得します。このコマンドは、パイプライン演算子 (|) を使用して、結果を ConvertTo-Html コマンドレット ("cth" というエイリアス) に送信します。
ConvertTo-Html コマンドには、出力を HTML の表に制限する Fragment パラメーターが含まれています。その結果、<HEAD> タグや <BODY> タグのような HTML ページの他の要素は省略されます。
例 8
C:\PS>get-eventlog -log "Windows PowerShell" | convertto-html -property id, level, task
説明
-----------
このコマンドは、Get-EventLog コマンドレットを使用して、"Windows PowerShell" イベント ログからイベントを取得します。
また、パイプライン演算子 (|) を使用してイベントを ConvertTo-Html コマンドレットに送信し、このコマンドレットがイベントを HTML 形式に変換します。
ConvertTo-Html コマンドは、Property パラメーターを使用して、イベントの ID、Level、および Task プロパティのみを選択します。
例 9
C:\PS>get-service A* | ConvertTo-Html -title "Windows Services: Server01" -body (get-date) -pre "<P>Generated by Corporate IT</P
>" -post "For details, contact Corporate IT." > services.htm; ii services.htm
説明
-----------
このコマンドは、コンピューターで稼動しているサービスのうち "A" で始まるサービスを表示する Web ページを作成して開きます。また、ConvertTo-Html の Title、Body、PreContent、および PostContent パラメーターを使用して出力をカスタマイズします。
コマンドの最初の部分は、Get-Service コマンドレットを使用して、コンピューターで稼動しているサービスのうち "A" で始まるサービスを取得します。また、パイプライン演算子 (|) を使用して結果を ConvertTo-Html コマンドレットに送信します。このコマンドはリダイレクト演算子 (>) を使用して、出力を Services.htm ファイルに送信します。
セミコロン (;) で最初のコマンドが終了し、2 番目のコマンドが開始します。2 番目のコマンドは Invoke-Item コマンドレット (エイリアスは ii) を使用して、既定のブラウザーで Services.htm ファイルを開きます。