Converte objetos Microsoft .NET Framework em HTML que podem ser exibidos em um navegador da Web.
Sintaxe
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>]
Descrição
O cmdlet ConvertTo-Html converte objetos .NET Framework em HTML que podem ser exibidos em um navegador da Web. É possível usar esse cmdlet para exibir a saída de um comando em uma página da Web.
É possível usar os parâmetros de ConvertTo-Html para selecionar propriedades do objeto, especificar um formato de lista ou tabela, especificar o título da página HTML, adicionar texto antes e depois do objeto e retornar apenas a tabela ou fragmento de lista, em vez de uma página DTD rígida.
Quando você envia vários objetos ao ConvertTo-Html, o Windows PowerShell cria a tabela (ou lista) baseado nas propriedades do primeiro objeto enviado. Se os objetos restantes não tiverem uma das propriedades especificadas, o valor da propriedade daquele objeto será uma célula vazia. Se os objetos restantes tiverem propriedades adicionais, esses valores de propriedade não serão incluídos no arquivo.
Parâmetros
-As <string>
Determina se o objeto é formatado como uma tabela ou uma lista. Os valores válidos são TABLE e LIST. O valor padrão é TABLE.
O valor TABLE gera uma tabela HTML que tem o formato semelhante ao da tabela do Windows PowerShell. A linha de cabeçalho exibe os nomes de propriedade. Cada linha da tabela representa um objeto e exibe os valores do objeto para cada propriedade.
O valor LIST gera uma tabela HTML de duas colunas para cada objeto que tenha o formato semelhante ao da lista do Windows PowerShell. A primeira coluna exibe o nome da propriedade; a segunda coluna exibe o valor da propriedade.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
Table |
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Body <string[]>
Especifica o texto a ser adicionado depois da tag de abertura <BODY>. Por padrão, não há texto nessa posição.
|
Necessário? |
false |
|
Posição? |
4 |
|
Valor padrão |
No text. |
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-CssUri <Uri>
Especifica o URI (Uniform Resource Identifier) da CSS (folha de estilos em cascata) que é aplicada ao arquivo HTML. O URI é incluído em um link de folha de estilos na saída.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Fragment
Gera apenas uma tabela HTML. As marcas HTML, HEAD, TITLE e BODY são omitidas.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Head <string[]>
Especifica o conteúdo da marca <HEAD>. O padrão é "<title>HTML TABLE</title>". Se você usar o parâmetro Head, o parâmetro Title será ignorado.
|
Necessário? |
false |
|
Posição? |
2 |
|
Valor padrão |
<title>HTML TABLE</title> |
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-InputObject <psobject>
Especifica os objetos a serem representados em HTML. Insira uma variável que contenha os objetos ou digite um comando ou expressão que obtenha os objetos.
Se você usar esse parâmetro para enviar vários objetos, como todos os serviços de um computador, o ConvertTo-Html criará uma tabela que exibe as propriedades de uma coleção ou matriz de objetos (System.Object[]). Para criar uma tabela dos objetos individuais, use o operador de pipeline para canalizar os objetos para ConvertTo-Html.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
true (ByValue) |
|
Aceitar caracteres curinga? |
false |
-PostContent <string[]>
Especifica o texto a ser adicionado depois da tag de fechamento </TABLE>. Por padrão, não há texto nessa posição.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
No text |
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-PreContent <string[]>
Especifica o texto a ser adicionado antes da tag de abertura <TABLE>. Por padrão, não há texto nessa posição.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
No text |
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Property <Object[]>
Inclui as propriedades especificadas dos objetos no HTML.
|
Necessário? |
false |
|
Posição? |
1 |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Title <string>
Especifica um título para o arquivo HTML, isto é, o texto que aparece entre as marcas <TITLE>.
|
Necessário? |
false |
|
Posição? |
3 |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
|
Entradas |
System.Management.Automation.PSObject É possível enviar qualquer objeto .NET para ConvertTo-Html. |
|
Saídas |
System.String ConvertTo-Html retorna uma série de cadeias de caracteres que incluem o HTML válido. |
Observações
Para usar esse cmdlet, canalize um ou mais objetos para o cmdlet ou use o parâmetro InputObject para especificar o objeto. Quando a entrada consiste em vários objetos, a saída desses dois métodos é muito diferente.
-- Quando você canaliza vários objetos para um cmdlet, o Windows PowerShell envia os objetos ao cmdlet um de cada vez. Como resultado, o ConvertTo-Html cria uma tabela que exibe os objetos individuais. Por exemplo, se você canalizar os processos em um computador para ConvertTo-Html, a tabela resultante exibirá todos os processos.
-- Quando você usa o parâmetro InputObject para enviar vários objetos, o ConvertTo-Html recebe esses objetos como uma coleção ou matriz. Como resultado, ele cria uma tabela que exibe a matriz e suas propriedades, não os itens da matriz. Por exemplo, se você usar InputObject para enviar os processos de um computador para o ConvertTo-Html, a tabela resultante exibirá uma matriz de objetos (System.Object[]) e suas propriedades.
Para conformidade com o XHTML Strict DTD, a marca DOCTYPE é modificada de maneira correspondente:
(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">)
Exemplo 1
C:\PS>convertto-html -inputobject (get-date) Descrição ----------- Esse comando cria uma página HTML que exibe as propriedades da data atual. Ele usa o parâmetro InputObject para enviar os resultados de um comando Get-Date ao cmdlet ConvertTo-Html.
Exemplo 2
C:\PS>get-alias | convertto-html > aliases.htm C:\PS> invoke-item aliases.htm Descrição ----------- Esse comando cria uma página HTML que lista os alias do Windows PowerShell no console atual. O comando usa o cmdlet Get-Alias para obter os alias. Ele usa o operador de pipeline (|) para enviar os aliases ao cmdlet ConvertTo-Html, que cria a página HTML.
Exemplo 3
C:\PS>get-eventlog -logname "Windows PowerShell | convertto-html > pslog.htm Descrição ----------- Esse comando cria uma página HTML chamada pslog.htm que exibe os eventos no log de eventos do Windows PowerShell no computador local. Ele usa o cmdlet Get-EventLog para obter os eventos no log do Windows PowerShell e, em seguida, usa o operador de pipeline (|) para enviar os eventos ao cmdlet ConvertTo-Html. O comando também usa o operador de redirecionamento (>) para enviar o código HTML ao arquivo pslog.htm.
Exemplo 4
C:\PS>get-process | convertto-html -property Name, Path, Company -title "Process Information" > proc.htm; ii proc.htm Descrição ----------- Esses comandos criam e abrem uma página HTML que lista o nome, o caminho e a empresa dos processos no computador local. O primeiro comando usa o cmdlet Get-Process para obter os objetos que representam os processos em execução no computador. O comando usa o operador de pipeline (|) para enviar os objetos do processo ao cmdlet ConvertTo-Html. O comando usa o parâmetro Property para selecionar três propriedades dos objetos do processo a serem incluídos na tabela. O comando usa o parâmetro Title para especificar um título para a página HTML. Ele também usa o operador de redirecionamento (>) para enviar o HTML resultante a um arquivo denominado Proc.htm. O segundo comando usa o cmdlet Invoke-Item (alias = ii) para abrir o Proc.htm no navegador padrão. Os dois comandos são separados por um ponto-e-vírgula (;).
Exemplo 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" /> ... Descrição ----------- Esse comando cria uma página HTML dos objetos de serviço que o cmdlet Get-Service retorna. O comando usa o parâmetro CssUri para especificar uma folha de estilos em cascata para a página HTML. O parâmetro CssUri acrescenta uma marca "<link rel="stylesheet" type="text/css" adicional ao HTML resultante. O atributo HREF na marca contém o nome da folha de estilos.
Exemplo 6
C:\PS>get-service | convertto-html -as LIST > services.htm Descrição ----------- Esse comando cria uma página HTML dos objetos de serviço que o cmdlet Get-Service retorna. O comando usa o parâmetro As para especificar um formato de lista. O operador de redirecionamento (>) envia o HTML resultante para o arquivo Services.htm.
Exemplo 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> Descrição ----------- Esse comando usa o ConvertTo-Html para gerar uma tabela HTML da data atual. O comando usa o cmdlet Get-Date para obter a data atual. Ele usa o operador de pipeline (|) para enviar os resultados ao cmdlet ConvertTo-Html (com o alias "cth"). O comando ConvertTo-Html inclui o parâmetro Fragment, que limita a saída a uma tabela HTML. Como resultado, os outros elementos de uma página HTML, como as marcas <HEAD> e <BODY>, são omitidos.
Exemplo 8
C:\PS>get-eventlog -log "Windows PowerShell" | convertto-html -property id, level, task Descrição ----------- Esse comando usa o cmdlet Get-EventLog para obter os eventos do log de eventos do "Windows PowerShell". Ele usa um operador de pipeline (|) para enviar os eventos ao cmdlet ConvertTo-Html, que os converte no formato HTML. O comando ConvertTo-Html usa o parâmetro Property para selecionar apenas as propriedades ID, Level e Task do evento.
Exemplo 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 Descrição ----------- Esse comando cria e abre uma página da Web que exibe os serviços do computador que são iniciados com "A". Ele usa os parâmetros Title, Body, PreContent e PostContent do ConvertTo-Html para personalizar a saída. A primeira parte do comando usa o cmdlet Get-Service para obter os serviços do computador que são iniciados com "A". O comando usa um operador de pipeline (|) para enviar os resultados ao cmdlet ConvertTo-Html. O comando usa um operador de redirecionamento (>) para enviar a saída ao arquivo Services.htm. Um ponto-e-vírgula (;) encerra o primeiro comando e inicia um segundo comando, que usa o cmdlet Invoke-Item (alias = "ii") para abrir o arquivo Services.htm no navegador padrão.
See Also