Format-Wide
Форматирует объекты в виде широкой таблицы, в которой отображается только одно свойство каждого объекта.
Синтаксис
Format-Wide [[-Property] <Object>] [-AutoSize] [-Column <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
Описание
Командлет Format-Wide форматирует объекты в виде широкой таблицы, в которой отображается только одно свойство каждого объекта. Чтобы узнать, какое свойство отображается, используйте параметр Property.
Параметры
-AutoSize
Настраивает размер и количество столбцов на основе ширины данных. По умолчанию размер и число столбцов определяются представлением. Использовать параметры AutoSize и Column в одной команде нельзя.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Column <int>
Задает число столбцов в отображаемых данных. Использовать параметры AutoSize и Column в одной команде нельзя.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-DisplayError
Выводит сообщения об ошибках в командной строке.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Expand <string>
Форматирует объект коллекции, а также объекты, содержащиеся в коллекции. Этот параметр служит для форматирования объектов, поддерживающих интерфейс ICollection (System.Collections). По умолчанию используется значение "EnumOnly".
Допустимые значения:
-- EnumOnly: отображаются свойства объектов, содержащихся в коллекции;
-- CoreOnly: отображаются свойства объекта коллекции;
-- Both: отображаются свойства объекта коллекции и свойства объектов, содержащихся в коллекции.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-Force
Переопределяет ограничения, препятствующие выполнению команды, не ставя под угрозу безопасность. Например, параметр Force позволяет переопределить атрибут "только чтение" или создать дополнительные каталоги в пути к файлу без изменения разрешений на доступ к файлам.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-GroupBy <Object>
Форматирует вывод в группы на основе общего свойства или значения. Введите выражение или свойство вывода.
Значение параметра GroupBy может быть новым вычисляемым свойством. Чтобы создать вычисляемое свойство, используйте хэш-таблицу. Допустимые ключи:
-- Name (или Label) <строка>
-- Expression <строка> или <блок скрипта>
-- FormatString <строка>
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-InputObject <psobject>
Задает объекты, подлежащие форматированию. Введите переменную, содержащую объекты, либо команду или выражение для получения объектов.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
true (ByValue) |
Принимать подстановочные знаки? |
false |
-Property <Object>
Задает свойства объекта, которые будут включены в вывод, и порядок их вывода. Подстановочные знаки разрешены.
Если этот параметр не указан, включаемые в вывод свойства зависят от отображаемого объекта. Имя параметра ("Property") указывать необязательно. Использовать параметры Property и View в одной команде нельзя.
Значение параметра Property может быть новым вычисляемым свойством. Чтобы создать вычисляемое свойство, используйте хэш-таблицу. Допустимые ключи:
-- Expression <строка> или <блок скрипта>
-- FormatString <строка>
Обязательно? |
false |
Позиция? |
1 |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-ShowError
Отправляет ошибки по конвейеру.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
-View <string>
Задает имя альтернативного табличного формата ("представления"). Использовать параметры Property и View в одной команде нельзя.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
<CommonParameters>
Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.
Ввод и вывод
Входным типом является тип объектов, которые можно передавать командлету по конвейеру. Возвращаемым типом является тип объектов, возвращаемых командлетом.
Входные данные |
System.Management.Automation.PSObject Любой объект можно передать командлету Format-Wide по конвейеру. |
Выходные данные |
Microsoft.PowerShell.Commands.Internal.Format Командлет Format-Wide возвращает объекты формата, представляющие таблицу. |
Примечания
Командлет Format-Wide также можно вызывать с помощью встроенного псевдонима "fw". Дополнительные сведения см. в разделе About_Aliases.
При указании параметра GroupBy предполагается, что объекты отсортированы. Перед группировкой объектов с помощью командлета Format-Custom выполните командлет Sort-Object, чтобы отсортировать их.
Параметр -View позволяет задать альтернативный формат таблицы. Можно использовать представления, определенные в файлах *.format.PS1XML в каталоге Windows PowerShell, или создать собственные представления в новых файлах PS1XML и включить их в Windows PowerShell с помощью командлета Update-FormatData.
Альтернативное представление, которое определяется параметром View, должно иметь табличный формат, в противном случае команда завершится ошибкой. Если альтернативное представление является списком, используйте командлет Format-List. Если альтернативное представление не является ни списком, ни таблицей, используйте командлет Format-Custom.
Пример 1
C:\PS>get-childitem | format-wide -column 3
Описание
-----------
Эта команда отображает имена файлов в текущем каталоге, выводя их на экран в трех столбцах. Командлет Get-ChildItem получает объекты, представляющие все файлы в каталоге. Оператор конвейера (|) передает объекты файлов по конвейеру командлету Format-Wide, который форматирует их, подготавливая к выводу. Параметр Column определяет количество столбцов.
Пример 2
C:\PS>get-childitem HKCU:\software\microsoft | format-wide -property pschildname -autosize
Описание
-----------
Эта команда отображает имена разделов реестра в разделе HKEY_CURRENT_USER\Software\Microsoft. Командлет Get-ChildItem получает объекты, представляющие разделы реестра. Путь указывается как "HKCU:" (один из дисков, предоставляемых поставщиком реестра Windows PowerShell), после чего следует путь к разделу. Оператор конвейера (|) передает объекты разделов реестра по конвейеру командлету Format-Wide, который форматирует их, подготавливая к выводу. Параметр Property определяет имя свойства, а параметр AutoSize изменяет размер столбцов, чтобы данные в них было удобнее читать.