Overzicht voor opmaakbestanden

Artikel
09/24/2021

De weergave-indeling voor de objecten die worden geretourneerd door opdrachten (cmdlets, functies en scripts) wordt gedefinieerd met behulp van opmaakbestanden (format.ps1xml-bestanden). Verschillende van deze bestanden worden geleverd door PowerShell voor het definiëren van de weergave-indeling voor de objecten die worden geretourneerd door PowerShell-opdrachten, zoals het object System.Diagnostics.Process dat wordt geretourneerd door de Get-Process cmdlet . U kunt echter ook uw eigen aangepaste opmaakbestanden maken om de standaardweergave-indelingen te overschrijven of u kunt een aangepast opmaakbestand schrijven om de weergave van objecten te definiëren die door uw eigen opdrachten worden geretourneerd.

Belangrijk

Opmaakbestanden bepalen niet de elementen van een object dat wordt geretourneerd naar de pijplijn. Wanneer een object wordt geretourneerd naar de pijplijn, zijn alle leden van dat object beschikbaar, zelfs als sommige niet worden weergegeven.

PowerShell gebruikt de gegevens in deze opmaakbestanden om te bepalen wat er wordt weergegeven en hoe de weergegeven gegevens worden opgemaakt. De weergegeven gegevens kunnen de eigenschappen van een object of de waarde van een script bevatten. Scripts worden gebruikt als u een waarde wilt weergeven die niet rechtstreeks beschikbaar is vanuit de eigenschappen van een object, zoals het toevoegen van de waarde van twee eigenschappen van een object en het weergeven van de som als een stukje gegevens. Het opmaken van de weergegeven gegevens wordt uitgevoerd door weergaven te definiëren voor de objecten die u wilt weergeven. U kunt één weergave voor elk object definiëren, u kunt één weergave voor meerdere objecten definiëren of u kunt meerdere weergaven voor hetzelfde object definiëren. Er is geen limiet voor het aantal weergaven dat u kunt definiëren.

Algemene functies van opmaakbestanden

Elk opmaakbestand kan de volgende onderdelen definiëren die kunnen worden gedeeld met alle weergaven die door het bestand zijn gedefinieerd:

Standaardconfiguratie-instelling, zoals of de gegevens die worden weergegeven in de rijen van tabellen, worden weergegeven op de volgende regel als de gegevens langer zijn dan de breedte van de kolom. Zie Het element Wrap voor TableRowEntryvoor meer informatie over deze instellingen.
Sets met objecten die kunnen worden weergegeven door een van de weergaven van het opmaakbestand. Zie Sets van objecten definiëren voor meer informatie over deze sets (aangeduid als selectiesets).
Algemene besturingselementen die kunnen worden gebruikt door alle weergaven van het opmaakbestand. Met besturingselementen hebt u meer controle over hoe gegevens worden weergegeven. Zie Aangepaste besturingselementen definiëren voor meer informatie over besturingselementen.

Weergaven opmaken

Opmaakweergaven kunnen objecten weergeven in een tabelindeling, lijstindeling, brede indeling en aangepaste indeling. Voor het grootste deel wordt elke opmaakdefinitie beschreven door een set XML-tags die de weergave beschrijven. Elke weergave bevat de naam van de weergave, de objecten die gebruikmaken van de weergave en de elementen van de weergave, zoals de kolom- en rijgegevens voor een tabelweergave.

Tabelweergave

Hiermee worden de eigenschappen van een object of een blokkeringswaarde van een script in een of meer kolommen vermeld. Elke kolom vertegenwoordigt één eigenschap van het object of een scriptwaarde. U kunt een tabelweergave definiëren die alle eigenschappen van een object we weergeven, een subset van de eigenschappen van een object of een combinatie van eigenschappen en scriptwaarden. Elke rij van de tabel vertegenwoordigt een geretourneerd object. Het maken van een tabelweergave is vergelijkbaar met wanneer u een object doorspijpt naar de Format-Table cmdlet . Zie Tabelweergave voor meer informatie over deze weergave.

Lijstweergave

Hiermee worden de eigenschappen van een object of een scriptwaarde in één kolom vermeld. In elke rij van de lijst wordt een optioneel label of de naam van de eigenschap weergegeven, gevolgd door de waarde van de eigenschap of het script. Het maken van een lijstweergave is vergelijkbaar met het doorspitten van een object naar de Format-List cmdlet . Zie Lijstweergave voor meer informatie over deze weergave.

Brede weergave

Een lijst met één eigenschap van een object of een scriptwaarde in een of meer kolommen. Er is geen label of koptekst voor deze weergave. Het maken van een brede weergave is vergelijkbaar met het doorspitten van een object naar de Format-Wide cmdlet . Zie Wide View voor meer informatie over deze weergave.

Aangepaste weergave

Geeft een aanpasbare weergave weer van objecteigenschappen of scriptwaarden die niet voldoen aan de strikte structuur van tabelweergaven, lijstweergaven of brede weergaven. U kunt een op zichzelf staande aangepaste weergave definiëren of u kunt een aangepaste weergave definiëren die wordt gebruikt door een andere weergave, zoals een tabelweergave of lijstweergave. Het maken van een aangepaste weergave is vergelijkbaar met het doorspitten van een object naar de Format-Custom cmdlet . Zie Aangepaste weergave voor meer informatie over deze weergave.

Onderdelen van een weergave

In de volgende XML-voorbeelden worden de xml-basisonderdelen van een weergave weergeven. De afzonderlijke XML-elementen variëren afhankelijk van de weergave die u wilt maken, maar de basisonderdelen van de weergaven zijn allemaal hetzelfde.

Om te beginnen heeft elke weergave een -element waarmee een gebruiksvriendelijke naam wordt opgegeven Name die wordt gebruikt om naar de weergave te verwijzen. een element dat definieert welke .NET-objecten door de weergave worden weergegeven en een ViewSelectedBy besturingselementelement dat de weergave definieert.

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

Binnen het besturingselement kunt u een of meer invoerelementen definiëren. Als u meerdere definities gebruikt, moet u opgeven welke .NET-objecten elke definitie gebruiken. Normaal gesproken is er slechts één vermelding, met slechts één definitie, nodig voor elk besturingselement.

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

Binnen elk invoerelement van een weergave geeft u de itemelementen op die de .NET-eigenschappen of -scripts definiëren die door die weergave worden weergegeven.


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

Zoals u in de voorgaande voorbeelden kunt zien, kan het opmaakbestand meerdere weergaven bevatten, kan een weergave meerdere definities bevatten en kan elke definitie meerdere items bevatten.

Voorbeeld van een tabelweergave

In het volgende voorbeeld ziet u de XML-tags die worden gebruikt voor het definiëren van een tabelweergave die twee kolommen bevat. Het element ViewDefinitions is het containerelement voor alle weergaven die zijn gedefinieerd in het opmaakbestand. Het element Weergave definieert de specifieke tabel, lijst, brede of aangepaste weergave. Binnen elk weergave-element geeft het element Naam de naam van de weergave op, het element ViewSelectedBy definieert de objecten die gebruikmaken van de weergave en de verschillende besturingselementelementen (zoals het element dat in het volgende voorbeeld wordt weergegeven) definiëren het TableControl type weergave.

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