Format-Wide (Microsoft.PowerShell.Utility)

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 в одной команде.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Column

Указывает количество столбцов на дисплее. Вы не можете использовать параметры AutoSize и Column в одной команде.

Тип :: Int32
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-DisplayError

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Expand

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

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

EnumOnly: отображает свойства объектов в коллекции.
CoreOnly: отображает свойства объекта коллекции.
Оба: отображает свойства объекта коллекции и свойства объектов в коллекции.

Тип :: String
Принятые значения:: CoreOnly, EnumOnly, оба
Позиция:: Именованный
Значение по умолчанию:: EnumOnly
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Force

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-GroupBy

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

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

Имя (или Метка) — <string>
Выражение - <string> или <script; block>
FormatString - <string>

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

Тип :: Объект
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-InputObject

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

Тип :: PSОбъект
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-Property

Указывает свойство объекта, которое отображается на экране. Подстановочные знаки разрешены.

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

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

Выражение - <string> или <script; block>
FormatString - <string>

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

Тип :: Объект
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: True

-ShowError

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-View

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

Тип :: String
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

PSObject

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

Выходы

Microsoft.PowerShell.Commands.Internal.Format

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

Примечания

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

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

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

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

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