Format-Wide
Форматирует объекты в виде широкой таблицы, в которой отображается только одно свойство каждого объекта.
Синтаксис
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
Указывает, что этот командлет переопределяет ограничения, препятствующие успешному выполнению команды, чтобы изменения не нарушали безопасность. Например, параметр 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 и View в одной команде.
Значение параметра 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
Указывает имя альтернативного формата таблицы или представления. Нельзя использовать параметры Property и View в одной команде.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
В этот командлет можно передать любой объект.
Выходные данные
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