Format-Wide

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Форматирует объекты в виде широкой таблицы, в которой отображается только одно свойство каждого объекта.

Синтаксис

Format-Wide
      [[-Property] <Object>]
      [-AutoSize]
      [-Column <int>]
      [-GroupBy <Object>]
      [-View <string>]
       [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <string>]
      [-InputObject <psobject>] 
      [<CommonParameters>]

Описание

Командлет Format-Wide форматирует объекты в виде широкой таблицы, отображающей только одно свойство каждого объекта. Параметр Property можно использовать для определения отображаемого свойства.

Примеры

Пример 1. Форматирование имен файлов в текущем каталоге

Эта команда отображает имена файлов в текущем каталоге в трех столбцах на весь экран.

Get-ChildItem | Format-Wide -Column 3

Командлет Get-ChildItem получает объекты, представляющие каждый файл в каталоге. Оператор конвейера (|) передает объекты файлов через конвейер Format-Wide, в который форматирует их для выходных данных. Параметр Column указывает количество столбцов.

Пример 2. Форматирование имен разделов реестра

Эта команда отображает имена разделов реестра в HKEY_CURRENT_USER\Software\Microsoft разделе.

Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize

Командлет Get-ChildItem получает объекты, представляющие ключи. Путь указывается как HKCU:один из дисков, предоставляемых поставщиком реестра PowerShell, за которым следует путь к ключу. Оператор конвейера (|) передает объекты раздела реестра через конвейер Format-Wide, в который форматирует их для выходных данных. Параметр Property задает имя свойства, а параметр AutoSize настраивает столбцы для удобочитаемости.

Пример 3. Устранение ошибок формата

В следующих примерах показаны результаты добавления параметров DisplayError или ShowError с выражением.

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

Параметры

-AutoSize

Корректирует размер столбца и количество столбцов в зависимости от ширины данных. По умолчанию размер и количество столбцов определяются представлением. Параметры autoSize и Column нельзя использовать в той же команде.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Column

Задает количество столбцов в отображаемых данных. Параметры autoSize и Column нельзя использовать в той же команде.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayError

Отображает сообщения об ошибках в командной строке. Этот параметр редко используется, но его можно использовать в качестве средства отладки при форматировании выражений Format-Wide в команде, и выражения, как представляется, не работают.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expand

Форматирует объект коллекции, а также объекты, содержащиеся в коллекции. Этот параметр предназначен для форматирования объектов, поддерживающих интерфейс System.Collections.ICollection . Значение по умолчанию — EnumOnly.

Допустимые значения:

  • EnumOnly: отображает свойства объектов в коллекции.
  • CoreOnly: отображает свойства объекта коллекции.
  • Both: отображает свойства объекта коллекции и свойства объектов в коллекции.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Указывает, что этот командлет переопределяет ограничения, которые препятствуют успешной команде, поэтому изменения не компрометирует безопасность. Например, принудительно переопределит атрибут только для чтения или создаст каталоги для завершения пути к файлу, но он не попытается изменить разрешения файла.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupBy

Форматирует вывод в группы на основе общего свойства или значения. Введите выражение или свойство вывода.

Значение параметра GroupBy может быть новым вычисляемым свойством. Вычисляемое свойство может быть блоком скрипта или хэш-таблицей. Допустимые пары "ключ-значение":

  • Name (или Label) - <string>
  • Expression - <string> или <script block>
  • FormatString - <string>

Дополнительные сведения см. в about_Calculated_Properties.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Указывает объекты для форматирования. Введите переменную, которая содержит объекты, или команду или выражение, которое возвращает объекты.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Property

Указывает свойство объекта, которое отображается в дисплее. Разрешено использовать подстановочные знаки.

Если этот параметр не указан, свойства включаются в вывод в зависимости от отображаемого объекта. Свойство имени параметра является необязательным. Параметры свойства и представления нельзя использовать в той же команде.

Значение параметра Property может быть новым вычисляемым свойством. Вычисляемое свойство может быть блоком скрипта или хэш-таблицей. Допустимые пары "ключ-значение":

  • Expression - <string> или <script block>
  • FormatString - <string>

Дополнительные сведения см. в about_Calculated_Properties.

Type:Object
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

Отправляет ошибки по конвейеру. Этот параметр редко используется, но его можно использовать в качестве средства отладки при форматировании выражений Format-Wide в команде, и выражения, как представляется, не работают.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-View

Задает имя альтернативного формата таблицы или представления. Параметры свойства и представления нельзя использовать в той же команде.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Входные данные

PSObject

Вы можете передать любой объект в этот командлет.

Выходные данные

Microsoft.PowerShell.Commands.Internal.Format

Этот командлет возвращает объекты формата, представляющие таблицу.

Примечания

PowerShell включает следующие псевдонимы для Format-Wide:

  • Все платформы:
    • fw

Параметр GroupBy предполагает, что объекты отсортированы. Используйте Sort-Object перед использованием Format-Custom для группировки объектов.

Параметр View позволяет указать альтернативный формат таблицы. Представления, определенные в *.format.PS1XML файлах в каталоге PowerShell, можно создавать собственные представления в новых файлах PS1XML и использовать Update-FormatData командлет для их включения в PowerShell.

Альтернативное представление для параметра View должно использовать формат таблицы. Если это не так, команда завершается ошибкой. Если альтернативное представление является списком, используйте Format-List. Если альтернативное представление не является списком или таблицей, используйте Format-Custom.