Update-ListView

Updates List View (created by Show-ListView) data.

Syntax

Update-ListView [-InfoTitle <String>] [-InfoDescription <String>] [-MissingDataMessage <String>] [-Icon <String>] -Data <Object> [-Property <Object[]>]

Detailed Description

This command updates the data displayed by List View that called the script the command is part of. Calling this command makes sense only when it's being used in script exposed as Action on the Show-ListView window. For example the main script might be listing all logged in users. And than the "Kick" action might be closing sessions for selected rows and refreshing the List view to take into account that the sessions are no longer connected. Another example is Task Manager script you can find in Toolbox. The List View shown by it shows tasks and when they were last run. If you choose to execute a task the Update-ListView command will later be called to update the data to account for the fact that the task's "Last Run" date has been updated.

© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-InfoTitle <String>

Aliases
Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InfoDescription <String>

Aliases
Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MissingDataMessage <String>

Aliases
Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Icon <String>

Aliases
Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Data <Object>

Data that you want to be sent to the list view for display.

Aliases
Required?	true
Position?	named
Default Value
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Property <Object[]>

If this parameter is specified - it allows for modifying the columns shown in the list view, otherwise the columns stay the same as in the original view.

Aliases
Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• Sitecore.Data.Items.Item

Outputs

The output type is the type of the objects that the cmdlet emits.

• System.String

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE

This example consists of 2 scripts - a report that shows a list view and the second one that updates the list view from an action.

# THE INITIAL SCRIPT showing the list of tasks in a list view
# This script does not yet make use of Update-ListView but tests the state for actions to be performed

Import-Function "Edit-TaskSchedule"

# Get all the items recursively where the TemplateName equals "Schedule".
Get-ChildItem -Path master:\system\Tasks\Schedules -Recurse | Where-Object { $_.TemplateName -eq "Schedule" } |
    Show-ListView -Property @{Label="Name"; Expression={ $_.DisplayName } },
        @{Label="Last Run"; Expression={ $_."Last Run" } },
        @{Label="Command"; Expression={ $_.Database.GetItem($_.Command).Name } },
        @{Label="From"; Expression={ Parse-TaskSchedule $_ "from"} },
        @{Label="To"; Expression={ Parse-TaskSchedule $_ "to"} },
        @{Label="On Week Days"; Expression={ Parse-TaskSchedule $_ "strWeekdays" } },
        @{Label="Run Every"; Expression={ Parse-TaskSchedule $_ "interval" } } `
        -Title "Task Manager"        
Close-Window



# NOW THE PROPER ACTION SCRIPT

# The Execute task action that (at the very end) updates the list with the latest tasks data
foreach($sheduleItem in $resultSet)
{
    $shedule = New-Object  -TypeName "Sitecore.Tasks.ScheduleItem" -ArgumentList $sheduleItem 
    $shedule.Execute();
}
Import-Function "Edit-TaskSchedule"
Get-ChildItem -Path master:\system\Tasks\Schedules -Recurse | Where-Object { $_.TemplateName -eq "Schedule" } | Update-ListView

Related Topics

• Show-ListView
• https://github.com/SitecorePowerShell/Console/