en-US/VfxSettings.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems 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" schema="maml" xmlns="http://msh">
  <command:command>
    <command:details>
      <command:name>Disable-VfxSetting</command:name>
      <maml:description>
        <maml:para>Disables specified visual effects.</maml:para>
      </maml:description>
      <command:verb>Disable</command:verb>
      <command:noun>VfxSetting</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Disables specified visual effects. Most of the settings match settings found SystemPropertiesAdvanced.exe -&gt; Performance -&gt; Visual effects.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Disable-VfxSetting</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
          <maml:name>Setting</maml:name>
          <maml:description>
            <maml:para>The following settings map to the settings found in SystemPropertiesAdvanced.exe -&gt; Performance -&gt; Visual effects.</maml:para>
            <maml:para>| Name in module | Name in GUI |
| ------------------------------ | ----------- |
| AeroPeek | Enable Peek |
| AnimateInsideWindows | Animate controls and elements inside windows |
| AnimateMenus | Fade or slide menus into view |
| AnimateMinimizeAndMaximize | Animate windows when minimizing and maximizing |
| AnimateTaskbar | Animations in the taskbar |
| AnimateTooltips | Fade or slide ToolTips into view |
| FontSmoothing | Smooth edges of screen fonts |
| IconShadows | Use drop shadows for icon labels on the desktop |
| MenuSelectionFade | Fade out menu items after clicking |
| MouseShadow | Show shadows under mouse pointer |
| SaveTaskbarThumbnails | Save taskbar thumbnail previews |
| ShowWindowContentWhileDragging | Show window contents while dragging |
| SlideOpenComboBoxes | Slide open combo boxes |
| SmoothScrollListBoxes | Smooth-scroll list boxes |
| Thumbnails | Show thumbnails instead of icons |
| TranslucentSelection | Show translucent selection rectangle |
| Transparency | Transparency effects (In Windows Settings) |
| WindowShadow | Show shadows under windows |</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">MartinGC94.VfxSettings.API.VfxSetting[]</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>Setting</maml:name>
        <maml:description>
          <maml:para>The following settings map to the settings found in SystemPropertiesAdvanced.exe -&gt; Performance -&gt; Visual effects.</maml:para>
          <maml:para>| Name in module | Name in GUI |
| ------------------------------ | ----------- |
| AeroPeek | Enable Peek |
| AnimateInsideWindows | Animate controls and elements inside windows |
| AnimateMenus | Fade or slide menus into view |
| AnimateMinimizeAndMaximize | Animate windows when minimizing and maximizing |
| AnimateTaskbar | Animations in the taskbar |
| AnimateTooltips | Fade or slide ToolTips into view |
| FontSmoothing | Smooth edges of screen fonts |
| IconShadows | Use drop shadows for icon labels on the desktop |
| MenuSelectionFade | Fade out menu items after clicking |
| MouseShadow | Show shadows under mouse pointer |
| SaveTaskbarThumbnails | Save taskbar thumbnail previews |
| ShowWindowContentWhileDragging | Show window contents while dragging |
| SlideOpenComboBoxes | Slide open combo boxes |
| SmoothScrollListBoxes | Smooth-scroll list boxes |
| Thumbnails | Show thumbnails instead of icons |
| TranslucentSelection | Show translucent selection rectangle |
| Transparency | Transparency effects (In Windows Settings) |
| WindowShadow | Show shadows under windows |</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">MartinGC94.VfxSettings.API.VfxSetting[]</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues />
    <maml:alertSet>
      <maml:alert>
        <maml:para />
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1 ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Disable-VfxSetting MouseShadow
```</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Disables the mouse cursor shadow effect.</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
      <command:example>
        <maml:title>--------- Example 2 ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Disable-VfxSetting (Get-VfxSetting).EnabledSettings
```</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Disables every setting that is currently enabled.</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version</maml:linkText>
        <command:uri />
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command>
    <command:details>
      <command:name>Enable-VfxSetting</command:name>
      <maml:description>
        <maml:para>Enables specified visual effects.</maml:para>
      </maml:description>
      <command:verb>Enable</command:verb>
      <command:noun>VfxSetting</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Enables specified visual effects. Most of the settings match settings found SystemPropertiesAdvanced.exe -&gt; Performance -&gt; Visual effects.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Enable-VfxSetting</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
          <maml:name>Setting</maml:name>
          <maml:description>
            <maml:para>The following settings map to the settings found in SystemPropertiesAdvanced.exe -&gt; Performance -&gt; Visual effects.</maml:para>
            <maml:para>| Name in module | Name in GUI |
| ------------------------------ | ----------- |
| AeroPeek | Enable Peek |
| AnimateInsideWindows | Animate controls and elements inside windows |
| AnimateMenus | Fade or slide menus into view |
| AnimateMinimizeAndMaximize | Animate windows when minimizing and maximizing |
| AnimateTaskbar | Animations in the taskbar |
| AnimateTooltips | Fade or slide ToolTips into view |
| FontSmoothing | Smooth edges of screen fonts |
| IconShadows | Use drop shadows for icon labels on the desktop |
| MenuSelectionFade | Fade out menu items after clicking |
| MouseShadow | Show shadows under mouse pointer |
| SaveTaskbarThumbnails | Save taskbar thumbnail previews |
| ShowWindowContentWhileDragging | Show window contents while dragging |
| SlideOpenComboBoxes | Slide open combo boxes |
| SmoothScrollListBoxes | Smooth-scroll list boxes |
| Thumbnails | Show thumbnails instead of icons |
| TranslucentSelection | Show translucent selection rectangle |
| Transparency | Transparency effects (In Windows Settings) |
| WindowShadow | Show shadows under windows |</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">MartinGC94.VfxSettings.API.VfxSetting[]</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>Setting</maml:name>
        <maml:description>
          <maml:para>The following settings map to the settings found in SystemPropertiesAdvanced.exe -&gt; Performance -&gt; Visual effects.</maml:para>
          <maml:para>| Name in module | Name in GUI |
| ------------------------------ | ----------- |
| AeroPeek | Enable Peek |
| AnimateInsideWindows | Animate controls and elements inside windows |
| AnimateMenus | Fade or slide menus into view |
| AnimateMinimizeAndMaximize | Animate windows when minimizing and maximizing |
| AnimateTaskbar | Animations in the taskbar |
| AnimateTooltips | Fade or slide ToolTips into view |
| FontSmoothing | Smooth edges of screen fonts |
| IconShadows | Use drop shadows for icon labels on the desktop |
| MenuSelectionFade | Fade out menu items after clicking |
| MouseShadow | Show shadows under mouse pointer |
| SaveTaskbarThumbnails | Save taskbar thumbnail previews |
| ShowWindowContentWhileDragging | Show window contents while dragging |
| SlideOpenComboBoxes | Slide open combo boxes |
| SmoothScrollListBoxes | Smooth-scroll list boxes |
| Thumbnails | Show thumbnails instead of icons |
| TranslucentSelection | Show translucent selection rectangle |
| Transparency | Transparency effects (In Windows Settings) |
| WindowShadow | Show shadows under windows |</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">MartinGC94.VfxSettings.API.VfxSetting[]</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues />
    <maml:alertSet>
      <maml:alert>
        <maml:para />
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1 ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Enable-VfxSetting MouseShadow
```</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Enables the mouse cursor shadow effect.</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
      <command:example>
        <maml:title>--------- Example 2 ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Enable-VfxSetting (Get-VfxSetting).DisabledSettings
```</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Enables every setting that is currently disabled.</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version</maml:linkText>
        <command:uri />
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command>
    <command:details>
      <command:name>Get-VfxSetting</command:name>
      <maml:description>
        <maml:para>Lists out all the visual effect settings this module handles and whether or not the setting is enabled or disabled.</maml:para>
      </maml:description>
      <command:verb>Get</command:verb>
      <command:noun>VfxSetting</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Lists out all the visual effect settings this module handles and whether or not the setting is enabled or disabled.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-VfxSetting</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters />
    <command:inputTypes />
    <command:returnValues />
    <maml:alertSet>
      <maml:alert>
        <maml:para />
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1 ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Get-VfxSetting | select -ExpandProperty EnabledSettings
```</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Lists out all the enabled settings.</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version</maml:linkText>
        <command:uri />
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>