Panoramica dei file di formattazione

Il formato di visualizzazione per gli oggetti restituiti dai comandi (cmdlet, funzioni e script) viene definito usando i file di formattazione (format.ps1xml). Molti di questi file vengono forniti da PowerShell per definire il formato di visualizzazione per tali oggetti restituiti dai comandi forniti da PowerShell, ad esempio l'oggetto System.Diagnostics.Process restituito dal cmdlet Get-Process. Tuttavia, è anche possibile creare file di formattazione personalizzati per sovrascrivere i formati di visualizzazione predefiniti oppure scrivere un file di formattazione personalizzato per definire la visualizzazione degli oggetti restituiti dai propri comandi.

Importante

La formattazione dei file non determina gli elementi di un oggetto restituito alla pipeline. Quando un oggetto viene restituito alla pipeline, tutti i membri di tale oggetto sono disponibili anche se alcuni non vengono visualizzati.

PowerShell usa i dati in questi file di formattazione per determinare cosa viene visualizzato e come vengono formattati i dati visualizzati. I dati visualizzati possono includere le proprietà di un oggetto o il valore di uno script. Gli script vengono usati se si desidera visualizzare un valore non disponibile direttamente dalle proprietà di un oggetto, ad esempio aggiungendo il valore di due proprietà di un oggetto e quindi visualizzando la somma come parte di dati. La formattazione dei dati visualizzati viene eseguita definendo le visualizzazioni per gli oggetti da visualizzare. È possibile definire una singola visualizzazione per ogni oggetto, è possibile definire una singola visualizzazione per più oggetti oppure definire più visualizzazioni per lo stesso oggetto. Non esiste alcun limite al numero di visualizzazioni che è possibile definire.

Caratteristiche comuni dei file di formattazione

Ogni file di formattazione può definire i componenti seguenti che possono essere condivisi tra tutte le visualizzazioni definite dal file:

• Impostazione di configurazione predefinita, ad esempio se i dati visualizzati nelle righe delle tabelle verranno visualizzati nella riga successiva se i dati sono più lunghi della larghezza della colonna. Per altre informazioni su queste impostazioni, vedere elemento Wrap per TableRowEntry.

• Set di oggetti che possono essere visualizzati da una delle visualizzazioni del file di formattazione. Per altre informazioni su questi set (detti set di selezione ), vedere Definizione di set di oggetti.

• Controlli comuni che possono essere usati da tutte le visualizzazioni del file di formattazione. I controlli offrono un controllo più corretto sulla modalità di visualizzazione dei dati. Per altre informazioni sui controlli, vedere Definizione di controlli personalizzati.

Formattazione delle visualizzazioni

La formattazione delle visualizzazioni può visualizzare oggetti in formato tabella, formato elenco, formato wide e formato personalizzato. Nella maggior parte dei casi, ogni definizione di formattazione viene descritta da un set di tag XML che descrivono la vista. Ogni vista contiene il nome della vista, gli oggetti che utilizzano la vista e gli elementi della vista, ad esempio le informazioni sulla colonna e sulla riga per una vista tabella.

Vista tabella

Elenca le proprietà di un oggetto o un valore di blocco di script in una o più colonne. Ogni colonna rappresenta una singola proprietà dell'oggetto o un valore di script. È possibile definire una vista tabella che visualizza tutte le proprietà di un oggetto, un subset delle proprietà di un oggetto o una combinazione di proprietà e valori di script. Ogni riga della tabella rappresenta un oggetto restituito. La creazione di una vista tabella è molto simile a quando si invia tramite pipe un oggetto al cmdlet Format-Table. Per altre informazioni su questa vista, vedere Vista tabella.

Visualizzazione elenco

Elenca le proprietà di un oggetto o un valore di script in una singola colonna. Ogni riga dell'elenco visualizza un'etichetta facoltativa o il nome della proprietà seguito dal valore della proprietà o dello script. La creazione di una visualizzazione elenco è molto simile al piping di un oggetto al cmdlet Format-List. Per altre informazioni su questa visualizzazione, vedere Visualizzazione elenco.

Visualizzazione wide

Elenca una singola proprietà di un oggetto o un valore di script in una o più colonne. Non esiste alcuna etichetta o intestazione per questa visualizzazione. La creazione di una visualizzazione estesa è molto simile a quella di un oggetto al cmdlet Format-Wide. Per altre informazioni su questa vista, vedere visualizzazione wide.

Vista personalizzata

Visualizza una visualizzazione personalizzabile delle proprietà degli oggetti o dei valori di script che non rispettano la struttura rigida delle visualizzazioni tabella, delle visualizzazioni elenco o delle visualizzazioni wide. È possibile definire una visualizzazione personalizzata autonoma oppure definire una visualizzazione personalizzata usata da un'altra visualizzazione, ad esempio una visualizzazione tabella o una visualizzazione elenco. La creazione di una visualizzazione personalizzata è molto simile a quella di un oggetto al cmdlet Format-Custom. Per altre informazioni su questa vista, vedere visualizzazione personalizzata.

Componenti di una visualizzazione

Negli esempi XML seguenti vengono illustrati i componenti XML di base di una visualizzazione. I singoli elementi XML variano a seconda della visualizzazione che si desidera creare, ma i componenti di base delle viste sono tutti uguali.

Per iniziare, ogni visualizzazione ha un elemento Name che specifica un nome descrittivo utilizzato per fare riferimento alla vista. Un elemento ViewSelectedBy che definisce gli oggetti .NET visualizzati dalla visualizzazione e un controllo elemento che definisce la visualizzazione.

<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>

All'interno dell'elemento di controllo è possibile definire uno o più elementi voce. Se si usano più definizioni, è necessario specificare gli oggetti .NET che usano ogni definizione. In genere per ogni controllo è necessaria una sola voce, con una sola definizione.

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

All'interno di ogni elemento voce di una visualizzazione, specificare l'elemento elementi che definiscono le proprietà o gli script .NET visualizzati da tale visualizzazione.

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

Come illustrato negli esempi precedenti, il file di formattazione può contenere più visualizzazioni, una vista può contenere più definizioni e ogni definizione può contenere più elementi.

Esempio di vista tabella

Nell'esempio seguente vengono illustrati i tag XML utilizzati per definire una vista tabella contenente due colonne. L'elemento ViewDefinitions è l'elemento contenitore per tutte le visualizzazioni definite nel file di formattazione. L'elemento View definisce la tabella, l'elenco, l'wide o la visualizzazione personalizzata specifica. All'interno di ogni elemento View, l'elemento Name specifica il nome della visualizzazione, l'elemento ViewSelectedBy definisce gli oggetti che utilizzano la visualizzazione e i diversi elementi di controllo (ad esempio l'elemento TableControl illustrato nell'esempio seguente) definiscono il tipo di visualizzazione.

<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>

Vedere anche

Creazione di un visualizzazione elenco

Creazione di una vista tabella

Creazione di un di visualizzazione wide

Creazione di controlli personalizzati

Scrittura di un file di formattazione e tipi di PowerShell