Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: List View (GroupBy)
# List View (GroupBy)

This example shows how to implement a list view that separates the rows of the list into groups.
This list view displays the properties of the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
This list view displays the properties of the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
objects returned by the [Get-Service](/powershell/module/Microsoft.PowerShell.Management/Get-Service)
cmdlet. For more information about the components of a list view, see [Creating a List View](./creating-a-list-view.md).

Expand All @@ -19,11 +19,11 @@ cmdlet. For more information about the components of a list view, see [Creating
formatting file.

1. Open Windows PowerShell, and run the following command to load the formatting file into the
current session: `Update-formatdata -prependpath PathToFormattingFile`.
current session: `Update-FormatData -PrependPath PathToFormattingFile`.

> [!WARNING]
> This formatting file defines the display of an object that is already defined by a Windows
> PowerShell formatting file. You must use the `prependPath` parameter when you run the cmdlet, and
> PowerShell formatting file. You must use the `PrependPath` parameter when you run the cmdlet, and
> you cannot load this formatting file as a module.

## Demonstrates
Expand All @@ -49,7 +49,7 @@ This formatting file demonstrates the following XML elements:

## Example

The following XML defines a list view that starts a new group whenever the value of the [System.Serviceprocess.Servicecontroller.Status](/dotnet/api/System.ServiceProcess.ServiceController.Status)
The following XML defines a list view that starts a new group whenever the value of the [System.ServiceProcess.ServiceController.Status](/dotnet/api/System.ServiceProcess.ServiceController.Status)
property changes. When each group is started, a custom label is displayed that includes the new
value of the property.

Expand Down Expand Up @@ -87,7 +87,7 @@ value of the property.
</Configuration>
```

The following example shows how Windows PowerShell displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
The following example shows how Windows PowerShell displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
objects after this format file is loaded. The blank lines added before and after the group label are
automatically added by Windows PowerShell.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: List View (Labels)
# List View (Labels)

This example shows how to implement a list view that displays a custom label for each row of the
list. This list view displays the properties of the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
list. This list view displays the properties of the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
object that is returned by the [Get-Service](/powershell/module/Microsoft.PowerShell.Management/Get-Service)
cmdlet. For more information about the components of a list view, see [Creating a List View](./creating-a-list-view.md).

Expand All @@ -19,12 +19,12 @@ cmdlet. For more information about the components of a list view, see [Creating
formatting file.

1. Open Windows PowerShell, and run the following command to load the formatting file into the
current session: `Update-formatdata -prependpath PathToFormattingFile`.
current session: `Update-FormatData -PrependPath PathToFormattingFile`.

> [!WARNING]

> This formatting file defines the display of an object that is already defined by a Windows
> PowerShell formatting file. You must use the `prependPath` parameter when you run the cmdlet, and
> PowerShell formatting file. You must use the `PrependPath` parameter when you run the cmdlet, and
> you cannot load this formatting file as a module.

## Demonstrates
Expand Down Expand Up @@ -92,7 +92,7 @@ the name of the property is displayed followed by the value of the property.
</Configuration>
```

The following example shows how Windows PowerShell displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
The following example shows how Windows PowerShell displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
objects after this format file is loaded.

```powershell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ For more information about the different types of views, see the following topic

## Example

The following example shows a `View` element that defines a table view for the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
The following example shows a `View` element that defines a table view for the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
object. The name of the view is "service".

```xml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ For more information about the components of a table view, see [Creating a Table

## Example

This example shows a `TableControl` element that is used to display the properties of the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
This example shows a `TableControl` element that is used to display the properties of the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
object.

```xml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ and [Custom View Components](./creating-custom-controls.md).

## Example

The following example shows how to specify the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
The following example shows how to specify the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
object for a list view. The same schema is used for table, wide, and custom views.

```xml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ topics:

## Example

This example shows a `View` element that defines a table view for the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
This example shows a `View` element that defines a table view for the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
object.

```xml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ referenced, see [Defining Sets of Objects](./defining-selection-sets.md).

## Example

The following example shows how to specify the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
The following example shows how to specify the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
object for a list view. The same schema is used for table, wide, and custom views.

```xml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Wide View (Basic)
---
# Wide View (Basic)

This example shows how to implement a basic wide view that displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
This example shows how to implement a basic wide view that displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
objects returned by the `Get-Service` cmdlet. For more information about the components of a wide
view, see [Creating a Wide View](./creating-a-wide-view.md).

Expand Down Expand Up @@ -37,7 +37,7 @@ This formatting file demonstrates the following XML elements:

## Example

The following XML defines a wide view that displays the value of the [System.Serviceprocess.Servicecontroller.Servicename](/dotnet/api/System.ServiceProcess.ServiceController.ServiceName) property.
The following XML defines a wide view that displays the value of the [System.ServiceProcess.ServiceController.ServiceName](/dotnet/api/System.ServiceProcess.ServiceController.ServiceName) property.

```xml
<?xml version="1.0" encoding="utf-8" ?>
Expand All @@ -63,7 +63,7 @@ The following XML defines a wide view that displays the value of the [System.Ser
</Configuration>
```

The following example shows how Windows PowerShell displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
The following example shows how Windows PowerShell displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
objects after this format file is loaded.

```powershell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Wide View (GroupBy)
---
# Wide View (GroupBy)

This example shows how to implement a wide view that displays groups of [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
This example shows how to implement a wide view that displays groups of [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
objects returned by the `Get-Service` cmdlet. For more information about the components of a wide
view, see [Creating a Wide View](./creating-a-wide-view.md).

Expand Down Expand Up @@ -40,7 +40,7 @@ This formatting file demonstrates the following XML elements:
## Example

The following XML defines a wide view that displays groups of objects. Each new group is started
when the value of the [System.Serviceprocess.Servicecontroller.Servicetype](/dotnet/api/System.ServiceProcess.ServiceController.ServiceType)
when the value of the [System.ServiceProcess.ServiceController.ServiceType](/dotnet/api/System.ServiceProcess.ServiceController.ServiceType)
property changes.

```xml
Expand Down Expand Up @@ -71,7 +71,7 @@ property changes.
</Configuration>
```

The following example shows how Windows PowerShell displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
The following example shows how Windows PowerShell displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
objects after this format file is loaded.

```powershell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@ its capitalization, change the function definition or the script filename.

### Syntax

The Syntax section of the Help topic is generated from the parameter list in the Param statement of
the function or script. To add detail to the Help topic syntax, such as the .NET type of a
The Syntax section of the Help topic is generated from the parameter list in the `param` statement
of the function or script. To add detail to the Help topic syntax, such as the .NET type of a
parameter, add the detail to the parameter list. If you don't specify a parameter type, the
**Object** type is inserted as the default value.

### Parameter List

The Parameters section of the Help topic is generated from the parameter list in the function or
script and from the descriptions that you add using the `.Parameters` keyword or comments in the
script and from the descriptions that you add using the `.PARAMETER` keyword or comments in the
parameter list.

Parameters appear in the Parameters section in the same order that they appear in the parameter
list. The spelling and capitalization of parameter names is also taken from the parameter list; it
isn't affected by the parameter name specified by the `.Parameter` keyword.
isn't affected by the parameter name specified by the `.PARAMETER` keyword.

### Common Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ The description of a parameter. You can include a `.PARAMETER` keyword for each
function or script.

The `.PARAMETER` keywords can appear in any order in the comment block, but the order in which the
parameters appear in the `Param` statement or function declaration determines the order in which the
parameters appear in the `param` statement or function declaration determines the order in which the
parameters appear in Help topic. To change the order of parameters in the Help topic, change the
order of the parameters in the `Param` statement or function declaration.
order of the parameters in the `param` statement or function declaration.

You can also specify a parameter description by placing a comment in the `Param` statement
immediately before the parameter variable name. If you use both a `Param` statement comment and a
You can also specify a parameter description by placing a comment in the `param` statement
immediately before the parameter variable name. If you use both a `param` statement comment and a
`.PARAMETER` keyword, the description associated with the `.PARAMETER` keyword is used, and the
`Param` statement comment is ignored.
`param` statement comment is ignored.

## `.EXAMPLE`

Expand Down
Loading