Public/New-FluenceButton.ps1
|
<# Copyright (c) 2026, Dan Cunningham. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #> function New-FluenceButton { <# .SYNOPSIS Builds a single button specification for Show-FluenceDialog. .DESCRIPTION Returns a Fluence.Button object carrying the caption, the result key, and the default and cancel flags. Pass one or more to Show-FluenceDialog -Buttons; a plain string there is shorthand for a button with no flags, so this cmdlet is what you use to mark one. .PARAMETER Text The button caption (and the default result key). .PARAMETER Name The result key; defaults to Text. .PARAMETER IsDefault Mark as the default button (activated by Enter). .PARAMETER IsCancel Mark as the cancel button (activated by Esc; skips input validation). .EXAMPLE New-FluenceButton -Text 'Sign in' -Name Login -IsDefault .EXAMPLE Show-FluenceDialog -Message 'Delete the folder?' -Buttons (New-FluenceButton 'Delete' -IsDefault), (New-FluenceButton 'Keep' -IsCancel) .OUTPUTS Fluence.Button .NOTES Does not require a host application. #> [CmdletBinding()] [OutputType('Fluence.Button')] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Justification = 'Builds an in-memory specification object; changes no system state.')] param ( [Parameter(Mandatory = $true, Position = 0)] [string]$Text, [Parameter()] [string]$Name, [Parameter()] [switch]$IsDefault, [Parameter()] [switch]$IsCancel ) if ([string]::IsNullOrWhiteSpace($Name)) { $Name = $Text } return [pscustomobject]@{ PSTypeName = 'Fluence.Button' Name = $Name Text = $Text IsDefault = [bool]$IsDefault IsCancel = [bool]$IsCancel } } |