Formata objetos como uma ampla tabela, a qual exibe somente uma propriedade de cada objeto.
Sintaxe
Format-Wide [[-Property] <Object>] [-AutoSize] [-Column <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
Descrição
O cmdlet Format-Wide formata objetos como uma ampla tabela, a qual exibe somente uma propriedade de cada objeto. Você pode usar o parâmetro Property para determinar qual propriedade será exibida.
Parâmetros
-AutoSize
Ajusta o tamanho e o número de colunas com base na largura dos dados. Por padrão, o tamanho e o número de colunas são determinados pela exibição. Você não pode usar os parâmetros AutoSize e Column no mesmo comando.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Column <int>
Especifica o número de colunas na exibição. Você não pode usar os parâmetros AutoSize e Column no mesmo comando.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-DisplayError
Exibe erros na linha de comando.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Expand <string>
Formata o objeto da coleção, bem como os objetos na coleção. Este parâmetro foi desenvolvido para formatar objetos que ofereçam suporte à interface ICollection (System.Collections). O valor padrão é EnumOnly.
Os valores válidos são:
-- EnumOnly: exibe as propriedades dos objetos na coleção.
-- CoreOnly: exibe as propriedades do objeto da coleção.
-- Both: exibe as propriedades do objeto da coleção, bem como dos objetos na coleção.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Force
Cancela as restrições que impedem a execução do comando, simplesmente para que as alterações não comprometam a segurança. Por exemplo, Force substituirá o atributo somente leitura ou criará diretórios para completar o caminho do arquivo, mas não tentará mudar as permissões do arquivo.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-GroupBy <Object>
Formata a saída em grupos com base em uma propriedade ou valor compartilhado. Digite uma expressão ou uma propriedade da saída.
O valor do parâmetro GroupBy pode ser uma nova propriedade calculada. Para criar uma propriedade calculada, use uma tabela de hash. As chaves válidas são:
-- Name (ou Label) <cadeia de caracteres>
-- Expression <cadeia de caracteres> ou <bloco de script>
-- FormatString <cadeia de caracteres>
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-InputObject <psobject>
Especifica os objetos a serem formatados. Insira uma variável que contenha os objetos, ou digite um comando ou uma expressão que obtenha os objetos.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByValue) |
Aceitar caracteres curinga? |
false |
-Property <Object>
Especifica as propriedades do objeto que aparecem na exibição e a ordem na qual são exibidas. Os caracteres curinga são permitidos.
Se você omitir esse parâmetro, as propriedades que aparecem na exibição dependerão do objeto sendo exibido. O nome do parâmetro ("Property") é opcional. Você não pode usar os parâmetros Property e View no mesmo comando.
O valor do parâmetro Property pode ser uma nova propriedade calculada. Para criar uma propriedade calculada, use uma tabela de hash. As chaves válidas são:
-- Expression <cadeia de caracteres> ou <bloco de script>
-- FormatString <cadeia de caracteres>
Necessário? |
false |
Posição? |
1 |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-ShowError
Envia erros pelo pipeline.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-View <string>
Especifica o nome de um formato ou "exibição" de tabela alternativa. Você não pode usar os parâmetros Property e View no mesmo comando.
Necessário? |
false |
Posição? |
named |
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 Você pode canalizar qualquer objeto para Format-Wide. |
Saídas |
Microsoft.PowerShell.Commands.Internal.Format Format-Wide retorna objetos de formato que representam a tabela. |
Observações
Você também pode se referir a Format-Wide usando seu alias interno, "fw". Para obter mais informações, consulte about_Aliases.
O parâmetro GroupBy supõe que os objetos estão classificados. Antes de usar Format-Custom para agrupar os objetos, use Sort-Object para classificá-los.
O parâmetro -View permite que você especifique um formato alternativo para a tabela. Você pode usar as exibições definidas nos arquivos *.format.PS1XML no diretório do Windows PowerShell ou criar suas próprias exibições em novos arquivos PS1XML e usar o cmdlet Update-FormatData para incluí-las no Windows PowerShell.
A exibição alternativa do parâmetro View deverá usar formato de tabela; caso contrário, o comando falhará. Se a exibição alternativa for uma lista, use Format-List. Se a exibição alternativa não for uma lista nem uma tabela, use Format-Custom.
Exemplo 1
C:\PS>get-childitem | format-wide -column 3 Descrição ----------- Este comando exibe os nomes dos arquivos no diretório atual em três colunas na tela. O cmdlet Get-ChildItem obtém objetos que representam cada arquivo no diretório. O operador de pipeline (|) passa os objetos do arquivo pelo pipeline para Format-Wide, que os formata para a saída. O parâmetro Column especifica o número de colunas na exibição.
Exemplo 2
C:\PS>get-childitem HKCU:\software\microsoft | format-wide -property pschildname -autosize Descrição ----------- Este comando exibe os nomes das chaves do Registro na chave HKEY_CURRENT_USER\Software\Microsoft. O cmdlet Get-ChildItem obtém objetos que representam as chaves. O caminho é especificado como "HKCU:", uma das unidades expostas pelo provedor Registry do Windows PowerShell, seguida pelo caminho da chave. O operador de pipeline (|) passa os objetos da chave do registro pelo pipeline para Format-Wide, que os formata para a saída. O parâmetro Property especifica o nome da propriedade; o parâmetro AutoSize ajusta as colunas para que sejam legíveis.