Lib/Core/en-US/DesktopManager.PowerShell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-DesktopMonitor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-DesktopMonitor</command:name> <command:verb>Get</command:verb> <command:noun>DesktopMonitor</command:noun> <maml:description> <maml:para>Gets the desktop monitors information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the desktop monitors information.</maml:para> <maml:para>Retrieves information about the desktop monitors connected to the system. You can filter the monitors by index, device ID, device name, connection status, or primary monitor status.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DesktopMonitor</maml:name> <!-- Parameter: Index --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Index</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PrimaryOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Index --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Index</maml:name> <maml:description> <maml:para>The index of the monitor to get information for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>The device ID of the monitor to get information for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The device name of the monitor to get information for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedOnly</maml:name> <maml:description> <maml:para>Get information for connected monitors only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PrimaryOnly</maml:name> <maml:description> <maml:para>Get information for the primary monitor only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- Example 1 ----------</maml:title> <dev:code>Get-DesktopMonitor</dev:code> <dev:remarks> <maml:para>Get information for all monitors</maml:para> <maml:para>Retrieves information for all connected desktop monitors.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2 ----------</maml:title> <dev:code>Get-DesktopMonitor -Index 1</dev:code> <dev:remarks> <maml:para>Get information for a specific monitor by index</maml:para> <maml:para>Retrieves information for the monitor specified by the index.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 3 ----------</maml:title> <dev:code>Get-DesktopMonitor -ConnectedOnly</dev:code> <dev:remarks> <maml:para>Get information for connected monitors only</maml:para> <maml:para>Retrieves information for all connected monitors only.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 4 ----------</maml:title> <dev:code>Get-DesktopMonitor -PrimaryOnly</dev:code> <dev:remarks> <maml:para>Get information for the primary monitor only</maml:para> <maml:para>Retrieves information for the primary monitor only.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DesktopPosition --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-DesktopPosition</command:name> <command:verb>Set</command:verb> <command:noun>DesktopPosition</command:noun> <maml:description> <maml:para>Sets the position of the desktop for one or more monitors.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the position of the desktop for one or more monitors.</maml:para> <maml:para>Sets the position of the desktop for one or more monitors. You can specify the monitor by index, device ID, or device name. You can also set the position for all monitors or only the primary monitor.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Index --> <command:syntaxItem> <maml:name>Set-DesktopPosition</maml:name> <!-- Parameter: Index --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Index</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Left --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Left</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Top --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Top</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Right --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Right</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Bottom --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7"> <maml:name>Bottom</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: DeviceID --> <command:syntaxItem> <maml:name>Set-DesktopPosition</maml:name> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="MonitorID"> <maml:name>DeviceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Left --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Left</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Top --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Top</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Right --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Right</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Bottom --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7"> <maml:name>Bottom</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: DeviceName --> <command:syntaxItem> <maml:name>Set-DesktopPosition</maml:name> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Left --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Left</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Top --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Top</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Right --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Right</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Bottom --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7"> <maml:name>Bottom</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: PrimaryOnly --> <command:syntaxItem> <maml:name>Set-DesktopPosition</maml:name> <!-- Parameter: PrimaryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PrimaryOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Left --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Left</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Top --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Top</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Right --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Right</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Bottom --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7"> <maml:name>Bottom</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Index --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Index</maml:name> <maml:description> <maml:para>The index of the monitor to set the position for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="MonitorID"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>The device ID of the monitor to set the position for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The device name of the monitor to set the position for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PrimaryOnly</maml:name> <maml:description> <maml:para>Set the position for the primary monitor only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Left --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Left</maml:name> <maml:description> <maml:para>The left position of the monitor.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Top --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Top</maml:name> <maml:description> <maml:para>The top position of the monitor.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Right --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Right</maml:name> <maml:description> <maml:para>The right position of the monitor.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Bottom --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7"> <maml:name>Bottom</maml:name> <maml:description> <maml:para>The bottom position of the monitor.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- Example 1 ----------</maml:title> <dev:code>Set the position for a specific monitor by index Set-DesktopPosition -Index 1 -Left 0 -Top 0 -Right 1920 -Bottom 1080</dev:code> </command:example> <command:example> <maml:title>---------- Example 2 ----------</maml:title> <dev:code>Set the position for the primary monitor only Set-DesktopPosition -PrimaryOnly -Left 0 -Top 0 -Right 1920 -Bottom 1080</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DesktopWallpaper --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-DesktopWallpaper</command:name> <command:verb>Get</command:verb> <command:noun>DesktopWallpaper</command:noun> <maml:description> <maml:para>Gets the current desktop wallpaper for one or more monitors.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the current desktop wallpaper for one or more monitors.</maml:para> <maml:para>Retrieves the current desktop wallpaper for one or more monitors. You can specify the monitor by index, device ID, or device name. You can also get the wallpaper for all monitors or only the primary monitor.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DesktopWallpaper</maml:name> <!-- Parameter: Index --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Index</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PrimaryOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Index --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Index</maml:name> <maml:description> <maml:para>The index of the monitor to get the wallpaper for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>The device ID of the monitor to get the wallpaper for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The device name of the monitor to get the wallpaper for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedOnly</maml:name> <maml:description> <maml:para>Get the wallpaper for connected monitors only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PrimaryOnly</maml:name> <maml:description> <maml:para>Get the wallpaper for the primary monitor only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- Example 1 ----------</maml:title> <dev:code>Get-DesktopWallpaper</dev:code> <dev:remarks> <maml:para>Get the wallpaper for all monitors</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2 ----------</maml:title> <dev:code>Get-DesktopWallpaper -Index 1</dev:code> <dev:remarks> <maml:para>Get the wallpaper for a specific monitor by index</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 3 ----------</maml:title> <dev:code>Get-DesktopWallpaper -PrimaryOnly</dev:code> <dev:remarks> <maml:para>Get the wallpaper for the primary monitor only</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DesktopWallpaper --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-DesktopWallpaper</command:name> <command:verb>Set</command:verb> <command:noun>DesktopWallpaper</command:noun> <maml:description> <maml:para>Sets the desktop wallpaper for one or more monitors.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the desktop wallpaper for one or more monitors.</maml:para> <maml:para>Sets the desktop wallpaper for one or more monitors. You can specify the monitor by index, device ID, or device name. You can also set the wallpaper for all monitors or only the primary monitor. Optionally, you can specify the wallpaper position.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Index --> <command:syntaxItem> <maml:name>Set-DesktopWallpaper</maml:name> <!-- Parameter: Index --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Index</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="MonitorID"> <maml:name>DeviceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PrimaryOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WallpaperPosition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6" aliases="Position"> <maml:name>WallpaperPosition</maml:name> <command:parameterValue required="true">DesktopWallpaperPosition</command:parameterValue> <dev:type> <maml:name>DesktopManager.DesktopWallpaperPosition</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WallpaperPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7" aliases="FilePath,Path"> <maml:name>WallpaperPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: All --> <command:syntaxItem> <maml:name>Set-DesktopWallpaper</maml:name> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WallpaperPosition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6" aliases="Position"> <maml:name>WallpaperPosition</maml:name> <command:parameterValue required="true">DesktopWallpaperPosition</command:parameterValue> <dev:type> <maml:name>DesktopManager.DesktopWallpaperPosition</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WallpaperPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7" aliases="FilePath,Path"> <maml:name>WallpaperPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Index --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Index</maml:name> <maml:description> <maml:para>The index of the monitor to set the wallpaper for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="MonitorID"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>The device ID of the monitor to set the wallpaper for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The device name of the monitor to set the wallpaper for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedOnly</maml:name> <maml:description> <maml:para>Set the wallpaper for connected monitors only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PrimaryOnly</maml:name> <maml:description> <maml:para>Set the wallpaper for the primary monitor only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>All</maml:name> <maml:description> <maml:para>Set the wallpaper for all monitors.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WallpaperPosition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6" aliases="Position"> <maml:name>WallpaperPosition</maml:name> <maml:description> <maml:para>The position of the wallpaper on the monitor.</maml:para> </maml:description> <command:parameterValue required="true">DesktopWallpaperPosition</command:parameterValue> <dev:type> <maml:name>DesktopManager.DesktopWallpaperPosition</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WallpaperPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7" aliases="FilePath,Path"> <maml:name>WallpaperPath</maml:name> <maml:description> <maml:para>The file path of the wallpaper image.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- Example 1 ----------</maml:title> <dev:code>Set-DesktopWallpaper -All -WallpaperPath "C:\Path\To\Wallpaper.jpg"</dev:code> <dev:remarks> <maml:para>Set the wallpaper for all monitors</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2 ----------</maml:title> <dev:code>Set-DesktopWallpaper -Index 1 -WallpaperPath "C:\Path\To\Wallpaper.jpg"</dev:code> <dev:remarks> <maml:para>Set the wallpaper for a specific monitor by index</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 3 ----------</maml:title> <dev:code>Set-DesktopWallpaper -PrimaryOnly -WallpaperPath "C:\Path\To\Wallpaper.jpg"</dev:code> <dev:remarks> <maml:para>Set the wallpaper for the primary monitor only</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |