New-UDPage

Creates a page within a dashboard.

SYNOPSIS

Creates a page within a dashboard.

SYNTAX

Simple (Default)

New-UDPage [-Id <String>] [-Name <String>] [-Url <String>] [-Description <String>] [-Role <String[]>]
 -Content <Endpoint> [-DefaultHomePage] [[-Title] <String>] [-OnLoading <ScriptBlock>]
 [-NavigationLayout <String>] [-Navigation <Hashtable[]>] [-Logo <String>] [-HeaderPosition <String>]
 [-HeaderColor <DashboardColor>] [-HeaderBackgroundColor <DashboardColor>] [-HeaderContent <Endpoint>]
 [-HideUserName] [-HideNavigation] [-Icon <Object>] [-LoadTitle <Endpoint>] [-Static] [-Generated]
 [-Layout <DesignerPageLayout>] [-BackgroundImage <String>] [-BackgroundRepeat] [-LogoComponent <Hashtable>]
 [-AutoInclude] [<CommonParameters>]

Advanced

New-UDPage [-Id <String>] [-Name <String>] [-Url <String>] [-Description <String>] [-Role <String[]>]
 -Content <Endpoint> [-DefaultHomePage] [[-Title] <String>] [-Blank] [-OnLoading <ScriptBlock>]
 [-HeaderPosition <String>] [-HeaderColor <DashboardColor>] [-HeaderBackgroundColor <DashboardColor>]
 [-HideUserName] [-HideNavigation] [-Icon <Object>] [-Static] [-Generated] [-Layout <DesignerPageLayout>]
 [-BackgroundRepeat] [-AutoInclude] [<CommonParameters>]

DynamicNav

New-UDPage [-Id <String>] [-Name <String>] [-Url <String>] [-Description <String>] [-Role <String[]>]
 -Content <Endpoint> [-DefaultHomePage] [[-Title] <String>] [-OnLoading <ScriptBlock>]
 [-NavigationLayout <String>] [-Logo <String>] [-LoadNavigation <Endpoint>] [-HeaderPosition <String>]
 [-HeaderColor <DashboardColor>] [-HeaderBackgroundColor <DashboardColor>] [-HeaderContent <Endpoint>]
 [-HideUserName] [-HideNavigation] [-Icon <Object>] [-LoadTitle <Endpoint>] [-Static] [-Generated]
 [-Layout <DesignerPageLayout>] [-BackgroundImage <String>] [-BackgroundRepeat] [-LogoComponent <Hashtable>]
 [-AutoInclude] [<CommonParameters>]

DESCRIPTION

Creates a page within a dashboard.

EXAMPLES

PARAMETERS

-Blank

Creates a page without a header.

Type: SwitchParameter
Parameter Sets: Advanced
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Content

The content of this page.

Type: Endpoint
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultHomePage

Whether this page is the default home page. Only one page can be a default home page.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

The description of this page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeaderBackgroundColor

The header background color.

Type: DashboardColor
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeaderColor

The header foreground color.

Type: DashboardColor
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeaderContent

Additional header content to include.

Type: Endpoint
Parameter Sets: Simple, DynamicNav
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeaderPosition

How to position the header.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: absolute, fixed, relative, static, sticky

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HideNavigation

Whether to hide the navigation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HideUserName

Whether to hide the user name when using an authenticated dashboard.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Icon

The icon to display in the navigation for this page.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

The ID of this page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoadNavigation

Custom navigation to load dynamically.

Type: Endpoint
Parameter Sets: DynamicNav
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoadTitle

Loads the title of this page dynamically.

Type: Endpoint
Parameter Sets: Simple, DynamicNav
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Logo

The URL of the logo to display in the header.

Type: String
Parameter Sets: Simple, DynamicNav
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of this page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Navigation

The static navigation to display on this page.

Type: Hashtable[]
Parameter Sets: Simple
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NavigationLayout

How to display the navigation.

Type: String
Parameter Sets: Simple, DynamicNav
Aliases:
Accepted values: Temporary, Permanent

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OnLoading

Content to display when the page is loading.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Role

The role required to view this page.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Title

The title to display in the header and title bar of this page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Url

The URL of this page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Static

A static page's content is not load dynamically when a user visits it and instead is constructed when the dashboard is started.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Generated

Whether this page was generated by the PowerShell Universal app designer.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Layout

The layout of components for this page. Used by the app designer.

Type: DesignerPageLayout
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BackgroundImage

The background image to display on this page.

Type: String
Parameter Sets: Simple, DynamicNav
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BackgroundRepeat

Whether to repeat the background image.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LogoComponent

The logo component to display in the header.

Type: Hashtable
Parameter Sets: Simple, DynamicNav
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AutoInclude

Automatically includes this page. No need to call Get-UDPage in the main app.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS