Compartilhar via

Visão geral do arquivo de formatação

O formato de exibição para os objetos retornados por comandos (cmdlets, funções e scripts) é definido usando arquivos de formatação (format.ps1xml). Vários desses arquivos são fornecidos pelo PowerShell para definir o formato de exibição desses objetos retornados por comandos fornecidos pelo PowerShell, como o objeto System.Diagnostics.Process retornado pelo cmdlet Get-Process. No entanto, você também pode criar seus próprios arquivos de formatação personalizados para substituir os formatos de exibição padrão ou pode escrever um arquivo de formatação personalizado para definir a exibição de objetos retornados por seus próprios comandos.

Importante

Os arquivos de formatação não determinam os elementos de um objeto que são retornados para o pipeline. Quando um objeto é retornado ao pipeline, todos os membros desse objeto ficam disponíveis mesmo que alguns não sejam exibidos.

O PowerShell usa os dados nesses arquivos de formatação para determinar o que é exibido e como os dados exibidos são formatados. Os dados exibidos podem incluir as propriedades de um objeto ou o valor de um script. Os scripts serão usados se você quiser exibir algum valor que não esteja disponível diretamente das propriedades de um objeto, como adicionar o valor de duas propriedades de um objeto e exibir a soma como um pedaço de dados. A formatação dos dados exibidos é feita definindo exibições para os objetos que você deseja exibir. Você pode definir uma única exibição para cada objeto, definir uma única exibição para vários objetos ou definir várias exibições para o mesmo objeto. Não há limite para o número de exibições que você pode definir.

Recursos comuns de arquivos de formatação

Cada arquivo de formatação pode definir os seguintes componentes que podem ser compartilhados em todas as exibições definidas pelo arquivo:

  • Configuração padrão, como se os dados exibidos nas linhas das tabelas serão exibidos na próxima linha se os dados forem maiores que a largura da coluna. Para obter mais informações sobre essas configurações, consulte Elemento Wrap para TableRowEntry.

  • Conjuntos de objetos que podem ser exibidos por qualquer uma das exibições do arquivo de formatação. Para obter mais informações sobre esses conjuntos (conhecidos como conjuntos de seleção ), consulte Definindo conjuntos de objetos.

  • Controles comuns que podem ser usados por todas as exibições do arquivo de formatação. Os controles oferecem um controle mais fino sobre como os dados são exibidos. Para obter mais informações sobre controles, consulte Definindo controles personalizados.

Exibições de formatação

Exibições de formatação podem exibir objetos em um formato de tabela, formato de lista, formato largo e formato personalizado. Na maioria das vezes, cada definição de formatação é descrita por um conjunto de marcas XML que descrevem a exibição. Cada exibição contém o nome da exibição, os objetos que usam a exibição e os elementos da exibição, como as informações de coluna e linha de um modo de exibição de tabela.

Modo de Exibição de Tabela

Lista as propriedades de um objeto ou um valor de bloco de script em uma ou mais colunas. Cada coluna representa uma única propriedade do objeto ou um valor de script. Você pode definir uma exibição de tabela que exibe todas as propriedades de um objeto, um subconjunto das propriedades de um objeto ou uma combinação de propriedades e valores de script. Cada linha da tabela representa um objeto retornado. A criação de um modo de exibição de tabela é muito semelhante a quando você redireciona um objeto para o cmdlet Format-Table. Para obter mais informações sobre esse modo de exibição, consulte Exibição de Tabela.

Exibição de Lista

Lista as propriedades de um objeto ou um valor de script em uma única coluna. Cada linha da lista exibe um rótulo opcional ou o nome da propriedade seguido pelo valor da propriedade ou script. A criação de uma exibição de lista é muito semelhante à canalização de um objeto para o cmdlet Format-List. Para obter mais informações sobre essa exibição, consulte Exibição de Lista.

Modo de Exibição Largo

Lista uma única propriedade de um objeto ou um valor de script em uma ou mais colunas. Não há nenhum rótulo ou cabeçalho para esse modo de exibição. A criação de uma exibição ampla é muito semelhante à canalização de um objeto para o cmdlet Format-Wide. Para obter mais informações sobre esse modo de exibição, consulte Wide View.

Exibição personalizada

Exibe uma exibição personalizável de propriedades de objeto ou valores de script que não aderem à estrutura rígida de exibições de tabela, exibições de lista ou exibições amplas. Você pode definir uma exibição personalizada autônoma ou definir uma exibição personalizada usada por outra exibição, como um modo de exibição de tabela ou exibição de lista. A criação de uma exibição personalizada é muito semelhante à canalização de um objeto para o cmdlet Format-Custom. Para obter mais informações sobre essa exibição, consulte Modo de Exibição Personalizado.

Componentes de uma exibição

Os exemplos XML a seguir mostram os componentes XML básicos de uma exibição. Os elementos XML individuais variam dependendo da exibição que você deseja criar, mas os componentes básicos das exibições são todos iguais.

Para começar, cada exibição tem um elemento Name que especifica um nome amigável que é usado para referenciar a exibição. um elemento ViewSelectedBy que define quais objetos .NET são exibidos pelo modo de exibição e um elemento de controle que define a exibição.

<ViewDefinitions>
  <View>
    <Name>NameOfView</Name>
    <ViewSelectedBy>...</ViewSelectedBy>
    <TableControl>...</TableControl>
  </View>
  <View>
    <Name>NameOfView</Name>
    <ViewSelectedBy>...</ViewSelectedBy>
    <ListControl>...</ListControl>
  <View>
  <View>
    <Name>NameOfView</Name>
    <ViewSelectedBy>...</ViewSelectedBy>
    <WideControl>...</WideControl>
  <View>
  <View>
    <Name>NameOfView</Name>
    <ViewSelectedBy>...</ViewSelectedBy>
    <CustomControl>...</CustomControl>
  </View>
</ViewDefinitions>

Dentro do elemento de controle, você pode definir um ou mais elementos de entrada . Se você usar várias definições, deverá especificar quais objetos .NET usam cada definição. Normalmente, apenas uma entrada, com apenas uma definição, é necessária para cada controle.

<ListControl>
  <ListEntries>
    <ListEntry>
      <EntrySelectedBy>...</EntrySelectedBy>
      <ListItems>...</ListItems>
    </ListEntry>
    <ListEntry>
        <EntrySelectedBy>...</EntrySelectedBy>
      <ListItems>...</ListItems>
    </ListEntry>
    <ListEntry>
        <EntrySelectedBy>...</EntrySelectedBy>
      <ListItems>...</ListItems>
    </ListEntry>
  </ListEntries>
</ListControl>

Em cada elemento de entrada de uma exibição, você especifica o item elementos que definem as propriedades ou scripts do .NET exibidos por esse modo de exibição.


<ListItems>
  <ListItem>...</ListItem>
  <ListItem>...</ListItem>
  <ListItem>...</ListItem>
</ListItems>

Conforme mostrado nos exemplos anteriores, o arquivo de formatação pode conter várias exibições, uma exibição pode conter várias definições e cada definição pode conter vários itens.

Exemplo de uma exibição de tabela

O exemplo a seguir mostra as marcas XML usadas para definir uma exibição de tabela que contém duas colunas. O elemento ViewDefinitions é o elemento de contêiner para todas as exibições definidas no arquivo de formatação. O elemento View define a tabela, a lista, a ampla ou a exibição personalizada específica. Em cada elemento View, o elemento Name especifica o nome da exibição, o elemento ViewSelectedBy define os objetos que usam a exibição e os diferentes elementos de controle (como o elemento TableControl mostrado no exemplo a seguir) definem o tipo da exibição.

<ViewDefinitions>
  <View>
    <Name>Name of View</Name>
    <ViewSelectedBy>
      <TypeName>Object to display using this view</TypeName>
      <TypeName>Object to display using this view</TypeName>
    </ViewSelectedBy>
    <TableControl>
      <TableHeaders>
        <TableColumnHeader>
          <Width></Width>
        </TableColumnHeader>
        <TableColumnHeader>
          <Width></Width>
        </TableColumnHeader>
      </TableHeaders>
      <TableRowEntries>
        <TableRowEntry>
          <TableColumnItems>
            <TableColumnItem>
              <PropertyName>Header for column 1</PropertyName>
            </TableColumnItem>
            <TableColumnItem>
              <PropertyName>Header for column 2</PropertyName>
            </TableColumnItem>
          </TableColumnItems>
        </TableRowEntry>
      </TableRowEntries>
    </TableControl>
  </View>
</ViewDefinitions>

Consulte Também

criando uma exibição de lista

criando um modo de exibição de tabela

criando uma de exibição ampla

criando controles personalizados

gravando um arquivo de formatação e tipos do PowerShell