| external help file | Module Name | online version | schema |
|---|---|---|---|
PSClock-help.xml |
PSClock |
2.0.0 |
Start a PSClock.
Start-PSClock [[-DateFormat] <String>] [-FontSize <Int32>] [-FontStyle <String>] [-FontWeight <String>] [-Color <String>] [-FontFamily <String>] [-OnTop] [-Position <Int32[]>] [-Force] [-Passthru] [<CommonParameters>]Start a WPF-based PSClock that will run in a background runspace. The clock will be displayed in the center of the screen. You can click and drag the clock to reposition using the left mouse button. You might have to try a few times to "grab" the clock. You can close the clock with a right-click or the Stop-PSClock command.
The command lets you specify any datetime format string. This is the same value you would use in a command like Get-Date -format U. Note that these strings are case-sensitive.
The clock runs in a separate runspace launched from your PowerShell session. If you close the session, the clock will also be closed.
The command is designed to only have one clock running at a time. If you try to start another clock from another PowerShell session, you will get a warning.
If you have saved PSClock settings, the exported values will be used unless you use -Force. The saved settings file will not be deleted.
PS C:\> Start-PSClockStart a new PSClock using the default parameter values. If you have saved PSClock settings, then those values will be used.
PS C:\> Start-PSClock -size 24 -FontFamily 'Bahnschrift Light' -OnTopStart a clock using specific font settings. The clock will be displayed center screen. It will use the default datetime format string.
Specify a font color like Green or an HTML code like '#FF1257EA'. You can also use any [System.Drawing.Brushes] color like Coral or SkyBlue.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: White
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecify a .NET format string value like F, or G. See https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings for more information.
Type: String
Parameter Sets: (All)
Aliases: format
Required: False
Position: 0
Default value: F
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecify a font family.
Type: String
Parameter Sets: (All)
Aliases: family
Required: False
Position: Named
Default value: Segoi UI
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecify a font size.
Type: Int32
Parameter Sets: (All)
Aliases: size
Required: False
Position: Named
Default value: 18
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecify a font style. Accepted values: Normal, Italic, Oblique
Type: String
Parameter Sets: (All)
Aliases: style
Accepted values: Normal, Italic, Oblique
Required: False
Position: Named
Default value: Normal
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecify a font weight. Accepted values: 'Normal', 'Bold', 'Light', 'Medium', 'SemiBold'
Type: String
Parameter Sets: (All)
Aliases: weight
Accepted values: 'Normal', 'Bold', 'Light', 'Medium', 'SemiBold'
Required: False
Position: Named
Default value: Normal
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseDo you want the clock to always be on top?
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseType: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseForce a new PSClock, ignoring any previously saved settings. The saved settings file will remain.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecify the clock position as an array of left and top values.
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
View the project's README file at https://bit.ly/3H01fJe.
Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/