Format-Wide
Formata objetos como uma tabela ampla que exibe apenas uma propriedade de cada objeto.
Sintaxe
Format-Wide
[[-Property] <Object>]
[-AutoSize]
[-Column <int>]
[-GroupBy <Object>]
[-View <string>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <string>]
[-InputObject <psobject>]
[<CommonParameters>]
Description
O Format-Wide
cmdlet formata objetos como uma tabela ampla que exibe apenas uma propriedade de cada objeto. Você pode usar o parâmetro Property para determinar qual propriedade é exibida.
Exemplos
Exemplo 1: Formatar nomes de arquivos no diretório atual
Este comando exibe os nomes dos arquivos no diretório atual em três colunas na tela.
Get-ChildItem | Format-Wide -Column 3
O Get-ChildItem
cmdlet obtém objetos que representam cada arquivo no diretório. O operador de pipeline (|
) passa os objetos de arquivo através do pipeline para Format-Wide
, que os formata para saída. O parâmetro Column especifica o número de colunas.
Exemplo 2: Formatar nomes de chaves de registo
Este comando exibe os nomes das chaves do Registro na HKEY_CURRENT_USER\Software\Microsoft
chave.
Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize
O Get-ChildItem
cmdlet obtém objetos que representam as chaves. O caminho é especificado como HKCU:
, uma das unidades expostas pelo provedor do Registro do PowerShell, seguido pelo caminho da chave. O operador de pipeline (|
) passa os objetos de chave do Registro através do pipeline para Format-Wide
, que os formata para saída. O parâmetro Property especifica o nome da propriedade e o parâmetro AutoSize ajusta as colunas para legibilidade.
Exemplo 3: Solução de problemas de erros de formato
Os exemplos a seguir mostram os resultados da adição dos parâmetros DisplayError ou ShowError com uma expressão.
PS /> Get-Date | Format-Wide { $_ / $null } -DisplayError
#ERR
PS /> Get-Date | Format-Wide { $_ / $null } -ShowError
Failed to evaluate expression " $_ / $null ".
+ CategoryInfo : InvalidArgument: (12/21/2018 8:18:01 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError
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 da coluna são determinados pelo modo de exibição. Não é possível usar os parâmetros AutoSize e Column no mesmo comando.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Column
Especifica o número de colunas na exibição. Não é possível usar os parâmetros AutoSize e Column no mesmo comando.
Tipo: | Int32 |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-DisplayError
Exibe erros na linha de comando. Esse parâmetro raramente é usado, mas pode ser usado como um auxílio de depuração quando você está formatando expressões em um Format-Wide
comando e as expressões não parecem estar funcionando.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Expand
Formata o objeto de coleção, bem como os objetos na coleção. Este parâmetro foi projetado para formatar objetos que suportam a interface System.Collections.ICollection . O valor predefinido é EnumOnly
.
Os valores válidos são:
EnumOnly
: Exibe as propriedades dos objetos na coleção.CoreOnly
: Exibe as propriedades do objeto de coleção.Both
: Exibe as propriedades do objeto de coleção e as propriedades dos objetos na coleção.
Tipo: | String |
Valores aceites: | CoreOnly, EnumOnly, Both |
Position: | Named |
Default value: | EnumOnly |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Force
Indica que esse cmdlet substitui as restrições que impedem que o comando seja bem-sucedido, apenas para que as alterações não comprometam a segurança. Por exemplo, Force substituirá o atributo somente leitura ou criará diretórios para concluir um caminho de arquivo, mas não tentará alterar as permissões de arquivo.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-GroupBy
Formata a saída em grupos com base em uma propriedade ou valor compartilhado. Insira uma expressão ou uma propriedade da saída.
O valor do parâmetro GroupBy pode ser uma nova propriedade calculada. A propriedade calculada pode ser um bloco de script ou uma tabela hash. Os pares chave-valor válidos são:
Name
(ouLabel
) -<string>
Expression
-<string>
ou<script block>
FormatString
-<string>
Para obter mais informações, consulte about_Calculated_Properties.
Tipo: | Object |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-InputObject
Especifica os objetos a serem formatados. Insira uma variável que contenha os objetos ou digite um comando ou expressão que obtenha os objetos.
Tipo: | PSObject |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-Property
Especifica a propriedade object que aparece na exibição. Curingas são permitidos.
Se você omitir esse parâmetro, as propriedades que aparecem na exibição dependem do objeto que está sendo exibido. O nome do parâmetro Propriedade é opcional. Não é possível usar os parâmetros Property e View no mesmo comando.
O valor do parâmetro Property pode ser uma nova propriedade calculada. A propriedade calculada pode ser um bloco de script ou uma tabela hash. Os pares chave-valor válidos são:
Expression
-<string>
ou<script block>
FormatString
-<string>
Para obter mais informações, consulte about_Calculated_Properties.
Tipo: | Object |
Position: | 0 |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | True |
-ShowError
Envia erros através do pipeline. Esse parâmetro raramente é usado, mas pode ser usado como um auxílio de depuração quando você está formatando expressões em um Format-Wide
comando e as expressões não parecem estar funcionando.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-View
Especifica o nome de um formato ou modo de exibição de tabela alternativo. Não é possível usar os parâmetros Property e View no mesmo comando.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
Entradas
Você pode canalizar qualquer objeto para este cmdlet.
Saídas
Microsoft.PowerShell.Commands.Internal.Format
Este cmdlet retorna objetos de formato que representam a tabela.
Notas
O PowerShell inclui os seguintes aliases para Format-Wide
:
- Todas as plataformas:
fw
O parâmetro GroupBy pressupõe que os objetos são classificados. Use Sort-Object
antes de usar Format-Custom
para agrupar os objetos.
O parâmetro View permite especificar um formato alternativo para a tabela. Você pode usar as exibições definidas nos *.format.PS1XML
arquivos no diretório do PowerShell ou pode criar suas próprias exibições em novos arquivos PS1XML e usar o Update-FormatData
cmdlet para incluí-las no PowerShell.
A exibição alternativa para o parâmetro View deve usar o formato de tabela, caso contrário, o comando falhará. Se o modo de exibição alternativo for uma lista, use Format-List
. Se o modo de exibição alternativo não for uma lista nem uma tabela, use Format-Custom
.