Citrix StoreFront SDK PowerShell Modules

New-STFWebReceiverPinnedLink

November 11, 2025

Contributed by:

Create a new Pinned Link

Syntax

New-STFWebReceiverPinnedLink [-Hyperlink] <String> [-DisplayText] <String> [[-TooltipText] <String>] [[-Icon] <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The cmdlet creates a new Pinned Link object containing the data specified in the parameters.

Parameters

Name	Description	Required?	Pipeline Input
Hyperlink	The hyperlink to be pinned.	true	true (ByValue)
DisplayText	Display text for the link.	true	true (ByValue)
TooltipText	Optional tooltip text for the pinned link.	false	true (ByValue)
Icon	Optional icon to include alongside pinned link.	false	true (ByValue)

Input Type

System.String

Parameter Hyperlink: The .NET System.String reference type

System.String

Parameter DisplayText: The .NET System.String reference type

System.String

Parameter TooltipText: The .NET System.String reference type

System.String

Parameter Icon: The .NET System.String reference type

Return Values

Link

The .NET Citrix.StoreFront.Model.ReceiverForWeb.Link reference type

Examples

EXAMPLE 1 Create a Pinned Links

$link = New-STFWebReceiverPinnedLink -Hyperlink "https://example.link" -DisplayText "Example" `
-TooltipText "An example pinned link" -Icon "C:\Users\Current\Download\icon.jpg"

$collection = @($newLink)
$receiver = Get-STFWebReceiverService
Set-STFWebReceiverPinnedLinks -WebReceiverService $receiver -PinnedLinks $collection -Enabled $true
<!--NeedCopy-->

REMARKS

Adds a new pinned link to the WebReceiver and enables displaying pinned likes in the Web UI

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-STFWebReceiverPinnedLink

November 11, 2025

Contributed by:

November 11, 2025

Contributed by:

New-STFWebReceiverPinnedLink

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

System.String

System.String

System.String

Return Values

Link

Examples

EXAMPLE 1 Create a Pinned Links

In this article