Format-Xml
SYNOPSIS
PSCX Cmdlet: Pretty print for XML files and XmlDocument objects.
SYNTAX
Path (Default)
Format-Xml [-AttributesOnNewLine] [-OmitXmlDeclaration] [-ConformanceLevel <ConformanceLevel>]
[-IndentString <String>] [-EnableDtd] [-Path] <PscxPathInfo[]> [<CommonParameters>]
Object
Format-Xml [-AttributesOnNewLine] [-OmitXmlDeclaration] [-ConformanceLevel <ConformanceLevel>]
[-IndentString <String>] [-EnableDtd] -InputObject <PSObject> [<CommonParameters>]
LiteralPath
Format-Xml [-AttributesOnNewLine] [-OmitXmlDeclaration] [-ConformanceLevel <ConformanceLevel>]
[-IndentString <String>] [-EnableDtd] [-LiteralPath] <PscxPathInfo[]> [<CommonParameters>]
DESCRIPTION
Pretty print for XML files and XmlDocument objects.
EXAMPLES
EXAMPLE 1
PS C:\>
C:\PS> Format-Xml foo.xml
Formats the XML in foo.xml in a "pretty print" manner.
EXAMPLE 2
PS C:\>
C:\PS> Format-Xml foo.xml -AttributesOnNewLine
Formats the XML in foo.xml in a "pretty print" manner putting each attribute on a new line.
EXAMPLE 3
PS C:\>
C:\PS> Format-Xml foo.xml -EnableDtd
Formats the XML in foo.xml which uses a DTD in a "pretty print" manner.
PARAMETERS
-LiteralPath
Specifies a path to the item. The value of -LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.
Type: Pscx.IO.PscxPathInfo[]
Parameter Sets: LiteralPath
Aliases: PSPath
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Path
Specifies the path to the file to process. Wildcard syntax is allowed.
Type: Pscx.IO.PscxPathInfo[]
Parameter Sets: Path
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-InputObject
Accepts an object as input to the cmdlet. Enter a variable that contains the objects or type a command or expression that gets the objects.
Type: System.Management.Automation.PSObject
Parameter Sets: Object
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-AttributesOnNewLine
Write attributes on a new line.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ConformanceLevel
Conformance level for XML.
Type: System.Xml.ConformanceLevel
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Auto
Accept pipeline input: False
Accept wildcard characters: False
-EnableDtd
Enables document type definition (DTD) processing.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IndentString
The string to use for indenting.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OmitXmlDeclaration
Omit the XML declaration element.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.