Criar uma exibição ampla

2022-01-21

Uma exibição ampla exibe um único valor para cada objeto que é exibido. O valor exibido pode ser o valor de uma propriedade de objeto .NET ou o valor de um script. Por padrão, não há nenhum rótulo ou cabeçalho para essa exibição.

Uma exibição ampla

o exemplo a seguir mostra como Windows PowerShell exibe o objeto System. Diagnostics. Process que é retornado pelo cmdlet Get-Process quando sua saída é canalizada para o cmdlet Format-Wide . (Por padrão, o cmdlet Get-Process retorna um modo de exibição de tabela.) Neste exemplo, as duas colunas são usadas para exibir o nome do processo para cada objeto retornado. O nome da Propriedade do objeto não é exibido, somente o valor da propriedade.

Get-Process | format-wide
AEADISRV                     agrsmsvc
Ati2evxx                     Ati2evxx
audiodg                      CCC
CcmExec                      communicator
Crypserv                     csrss
csrss                        DevDtct2
DM1Service                   dpupdchk
dwm                          DxStudio
EXCEL                        explorer
GoogleToolbarNotifier        GrooveMonitor
hpqwmiex                     hpservice
Idle                         InoRpc
InoRT                        InoTask
ipoint                       lsass
lsm                          MOM
MSASCui                      notepad
...                          ...

Definindo a exibição ampla

O XML a seguir mostra o esquema de exibição ampla para o objeto System. Diagnostics. Process .

View>
  <Name>process</Name>
  <ViewSelectedBy>
    <TypeName>System.Diagnostics.Process</TypeName>
  </ViewSelectedBy>
  <GroupBy>...</GroupBy>
  <Controls>...</Controls>
  <WideControl>
    <WideEntries>
      <WideEntry>
        <WideItem>
          <PropertyName>ProcessName</PropertyName>
        </WideItem>
      </WideEntry>
    </WideEntries>
  </WideControl>
</View>

Os seguintes elementos XML são usados para definir uma exibição ampla:

O elemento View é o elemento pai da exibição larga. (Este é o mesmo elemento pai para a tabela, lista e exibições de controle personalizado.)
O elemento Name especifica o nome da exibição. Esse elemento é necessário para todas as exibições.
O elemento ViewSelectedBy define os objetos que usam a exibição. Este elemento é obrigatório.
O elemento GroupBy define quando um novo grupo de objetos é exibido. Um novo grupo é iniciado sempre que o valor de uma propriedade ou script específico é alterado. Esse elemento é opcional.
Os elementos Controls definem os controles personalizados que são definidos pela exibição larga. Os controles oferecem uma maneira de especificar como os dados são exibidos. Esse elemento é opcional. Uma exibição pode definir seus próprios controles personalizados ou pode usar controles comuns que podem ser usados por qualquer exibição no arquivo de formatação. Para obter mais informações sobre controles personalizados, consulte criando controles personalizados.
O elemento WideControl e seus elementos filho definem o que é exibido na exibição. No exemplo anterior, a exibição foi projetada para exibir a propriedade System. Diagnostics. Process. ProcessName .

Para obter um exemplo de um arquivo de formatação completo que define uma exibição larga simples, consulte Wide View (básica).

Fornecendo definições para sua ampla exibição

Exibições amplas podem fornecer uma ou mais definições usando os elementos filho do elemento WideControl . Normalmente, uma exibição terá apenas uma definição. No exemplo a seguir, a exibição fornece uma única definição que exibe o valor da propriedade System. Diagnostics. Process. ProcessName . Uma exibição ampla pode exibir o valor de uma propriedade ou o valor de um script (não mostrado no exemplo).

<WideControl>
  <AutoSize/>
  <ColumnNumber></ColumnNumber>
  <WideEntries>
    <WideEntry>
      <WideItem>
        <PropertyName>ProcessName</PropertyName>
      </WideItem>
    </WideEntry>
  </WideEntries>
</WideControl>

Os seguintes elementos XML podem ser usados para fornecer definições para uma exibição ampla:

O elemento WideControl e seus elementos filho definem o que é exibido na exibição.
O elemento AutoSize especifica se o tamanho da coluna e o número de colunas são ajustados com base no tamanho dos dados. Esse elemento é opcional.
O elemento ColumnNumber especifica o número de colunas exibidas na exibição ampla. Esse elemento é opcional.
O elemento WideEntries fornece as definições da exibição. Na maioria dos casos, uma exibição terá apenas uma definição. Este elemento é obrigatório.
O elemento WideEntry fornece uma definição da exibição. Pelo menos um WideEntry é necessário; no entanto, não há nenhum limite máximo para o número de elementos que você pode adicionar. Na maioria dos casos, uma exibição terá apenas uma definição.
O elemento EntrySelectedBy especifica os objetos que são exibidos por uma definição específica. Esse elemento é opcional e só é necessário quando você define vários elementos WideEntry que exibem objetos diferentes.
O elemento WideItem especifica os dados que são exibidos pela exibição. Ao contrário de outros tipos de exibições, um controle amplo pode exibir apenas um item.
O elemento PropertyName especifica a propriedade cujo valor é exibido pela exibição. Você deve especificar uma propriedade ou um script, mas não pode especificar ambos.
O elemento scriptblock especifica o script cujo valor é exibido pela exibição. Você deve especificar um script ou uma propriedade, mas não pode especificar ambos.
O elemento FormatString especifica um padrão que é usado para exibir os dados. Esse elemento é opcional.

Para obter um exemplo de um arquivo de formatação completo que define uma ampla definição de exibição, consulte Wide View (básica).

Definindo os objetos que usam a exibição ampla

Há duas maneiras de definir quais objetos .NET usam a exibição ampla. Você pode usar o elemento ViewSelectedBy para definir os objetos que podem ser exibidos por todas as definições da exibição ou pode usar o elemento EntrySelectedBy para definir quais objetos são exibidos por uma definição específica da exibição. Na maioria dos casos, uma exibição tem apenas uma definição, portanto, os objetos são normalmente definidos pelo elemento ViewSelectedBy .

O exemplo a seguir mostra como definir os objetos que são exibidos pela exibição ampla usando os elementos ViewSelectedBy e TypeName . Não há nenhum limite para o número de elementos TypeName que você pode especificar, e sua ordem não é significativa.

<View>
  <Name>System.ServiceProcess.ServiceController</Name>
  <ViewSelectedBy>
    <TypeName>System.Diagnostics.Process</TypeName>
  </ViewSelectedBy>
  <WideControl>...</WideControl>
</View>

Os seguintes elementos XML podem ser usados para especificar os objetos que são usados pela exibição ampla:

O elemento ViewSelectedBy define quais objetos são exibidos pela exibição larga.
O elemento TypeName especifica o .NET que é exibido pela exibição. O nome do tipo .NET totalmente qualificado é necessário. Você deve especificar pelo menos um tipo ou seleção definida para a exibição, mas não há um número máximo de elementos que possam ser especificados.

Para obter um exemplo de um arquivo de formatação completo, consulte Wide View (básica).

O exemplo a seguir usa os elementos ViewSelectedBy e SelectionSetName . Use conjuntos de seleção em que você tenha um conjunto de objetos relacionado que são exibidos usando várias exibições, como quando você define uma exibição ampla e uma exibição de tabela para os mesmos objetos. Para obter mais informações sobre como criar um conjunto de seleção, consulte definindo conjuntos de seleção.

<View>
  <Name>System.ServiceProcess.ServiceController</Name>
  <ViewSelectedBy>
    <SelectionSetName>.NET Type Set</SelectionSetName>
  </ViewSelectedBy>
  <WideControl>...</WideControl>
</View>

Os seguintes elementos XML podem ser usados para especificar os objetos que são usados pela exibição ampla:

O elemento ViewSelectedBy define quais objetos são exibidos pela exibição larga.
O elemento SelectionSetName especifica um conjunto de objetos que podem ser exibidos pela exibição. Você deve especificar pelo menos um conjunto de seleção ou tipo para a exibição, mas não há um número máximo de elementos que possam ser especificados.

O exemplo a seguir mostra como definir os objetos exibidos por uma definição específica da exibição ampla usando o elemento EntrySelectedBy . Usando esse elemento, você pode especificar o nome do tipo .NET do objeto, um conjunto de objetos de seleção ou uma condição de seleção que especifica quando a definição é usada. Para obter mais informações sobre como criar condições de seleção, consulte definindo condições para exibir dados.

<WideEntry>
  <EntrySelectedBy>
    <TypeName>.NET Type</TypeName>
  </EntrySelectedBy>
</WideEntry>

Os seguintes elementos XML podem ser usados para especificar os objetos que são usados por uma definição específica da exibição ampla:

O elemento EntrySelectedBy define quais objetos são exibidos pela definição.
O elemento TypeName especifica o .NET que é exibido pela definição. Ao usar esse elemento, o nome do tipo .NET totalmente qualificado é necessário. Você deve especificar pelo menos um tipo, um conjunto de seleção ou uma condição de seleção para a definição, mas não há um número máximo de elementos que possam ser especificados.
O elemento SelectionSetName (não mostrado) especifica um conjunto de objetos que podem ser exibidos por essa definição. Você deve especificar pelo menos um tipo, um conjunto de seleção ou uma condição de seleção para a definição, mas não há um número máximo de elementos que possam ser especificados.
O elemento SelectionCondition (não mostrado) especifica uma condição que deve existir para que essa definição seja usada. Você deve especificar pelo menos um tipo, um conjunto de seleção ou uma condição de seleção para a definição, mas não há um número máximo de elementos que possam ser especificados. Para obter mais informações sobre como definir condições de seleção, consulte definindo condições para exibir dados.

Exibindo grupos de objetos em uma exibição ampla

Você pode separar os objetos que são exibidos pela exibição ampla em grupos. isso não significa que você defina um grupo, somente esse Windows PowerShell iniciará um novo grupo sempre que o valor de uma propriedade ou script específico for alterado. No exemplo a seguir, um novo grupo é iniciado sempre que o valor da propriedade System. ServiceProcess. ServiceController. ServiceType é alterado.

<GroupBy>
  <Label>Service Type</Label>
  <PropertyName>ServiceType</PropertyName>
</GroupBy>

Os seguintes elementos XML são usados para definir quando um grupo é iniciado:

O elemento GroupBy define a propriedade ou o script que inicia o novo grupo e define como o grupo é exibido.
O elemento PropertyName especifica a propriedade que inicia um novo grupo sempre que seu valor é alterado. Você deve especificar uma propriedade ou um script para iniciar o grupo, mas não pode especificar ambos.
O elemento scriptblock especifica o script que inicia um novo grupo sempre que seu valor é alterado. Você deve especificar um script ou uma propriedade para iniciar o grupo, mas não pode especificar ambos.
O elemento Label define um rótulo que é exibido no início de cada grupo. além do texto especificado por esse elemento, Windows PowerShell exibe o valor que disparou o novo grupo e adiciona uma linha em branco antes e depois do rótulo. Esse elemento é opcional.
O elemento CustomControl define um controle que é usado para exibir os dados. Esse elemento é opcional.
O elemento CustomControlName especifica um controle comum ou de exibição que é usado para exibir os dados. Esse elemento é opcional.

Para obter um exemplo de um arquivo de formatação completo que define grupos, consulte Wide View (GroupBy).

Usando cadeias de caracteres de formato

As cadeias de caracteres de formatação podem ser adicionadas a uma exibição ampla para definir ainda mais como os dados são exibidos. O exemplo a seguir mostra como definir uma cadeia de caracteres de formatação para o valor da StartTime propriedade.

<WideItem>
  <PropertyName>StartTime</PropertyName>
  <FormatString>{0:MMM} {0:DD} {0:HH}:{0:MM}</FormatString>
</WideItem>

Os seguintes elementos XML podem ser usados para especificar um padrão de formato:

O elemento WideItem especifica os dados que são exibidos pela exibição.
O elemento PropertyName especifica a propriedade cujo valor é exibido pela exibição. Você deve especificar uma propriedade ou um script, mas não pode especificar ambos.
O elemento FormatString especifica um padrão de formato que define como o valor de propriedade ou script é exibido na exibição
O elemento scriptblock (não mostrado) especifica o script cujo valor é exibido pela exibição. Você deve especificar um script ou uma propriedade, mas não pode especificar ambos.

No exemplo a seguir, o ToString método é chamado para formatar o valor do script. Os scripts podem chamar qualquer método de um objeto. Portanto, se um objeto tiver um método, como ToString , que tem parâmetros de formatação, o script poderá chamar esse método para formatar o valor de saída do script.

<WideItem>
  <ScriptBlock>
    [String]::Format("{0,-10} {1,-8}", $_.LastWriteTime.ToString("d"), $_.LastWriteTime.ToString("t"))
  </ScriptBlock>
</WideItem>

O elemento XML a seguir pode ser usado para chamar o ToString método:

O elemento WideItem especifica os dados que são exibidos pela exibição.
O elemento scriptblock (não mostrado) especifica o script cujo valor é exibido pela exibição. Você deve especificar um script ou uma propriedade, mas não pode especificar ambos.

Consulte Também

Exibição ampla (Básica)

Exibição ampla (GroupBy)

Escrever um arquivo de formatação do PowerShell