New-UDImage

Synopsis

An image component.

Syntax

New-UDImage [-Id <String>] [-Url <String>] [-Height <Int32>] [-Width <Int32>] [-Attributes <Hashtable>] [-ClassName <String>] [<CommonParameters>]

New-UDImage [-Id <String>] [-Path <String>] [-Height <Int32>] [-Width <Int32>] [-Attributes <Hashtable>] [-ClassName <String>] [<CommonParameters>]

Description

An image component.

Parameters

-Id

The ID of this component.

Required?                    false
Position?                    named
Default value                ([Guid]::NewGuid())
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Url

The URL to the image.

Required?                    false
Position?                    named
Default value                https://cdnweb.devolutions.net/web/common/logos/powershell-universal-logo.svg
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Path

The path to a local image.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Height

The height in pixels.

Required?                    false
Position?                    named
Default value                0
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Width

The width in pixels.

Required?                    false
Position?                    named
Default value                0
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Attributes

Additional attributes to apply to the img tag.

Required?                    false
Position?                    named
Default value                @{}
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ClassName

A CSS class to apply to the image.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Outputs

Examples

Example 1: Basic image

New-UDImage -Url "https://cdnweb.devolutions.net/web/common/logos/powershell-universal-logo.svg"

Displays an image.

Example 2: Local image

$Image = Get-ChildItem "$PSScriptRoot\*.png" | Select-Object -First 1
New-UDImage -Path ($Image.FullName)

Displays a local image.

Example 3: Image with height and width

New-UDImage -Url "https://cdnweb.devolutions.net/web/common/logos/powershell-universal-logo.svg" -Height 100 -Width 100

Displays an image with a height and width.

Example 4: Image with style

New-UDImage -Url "https://cdnweb.devolutions.net/web/common/logos/powershell-universal-logo.svg" -Attributes @{
   style = @{
       borderRadius = '50%'
   }
}

Displays an image with a style attribute.