Set-SPListOverlay

Sets calendar overlays for the given list.

Set-SPListOverlay -Color <CalendarOverlayColor> -OverlayList <SPListPipeBind> [-OverlayTitle [<String>]] [-OverlayDescription [<String>]] -TargetList <SPListPipeBind> [-ViewName [<String>]] [-DoNotAlwaysShow [<SwitchParameter>]] [-ClearExisting [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Set-SPListOverlay -Color <CalendarOverlayColor> [-OverlayTitle [<String>]] [-OverlayDescription [<String>]] -OwaUrl <String> -WebServiceUrl <String> -TargetList <SPListPipeBind> [-ViewName [<String>]] [-DoNotAlwaysShow [<SwitchParameter>]] [-ClearExisting [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Set-SPListOverlay -OverlayLists <SPListPipeBind[]> -TargetList <SPListPipeBind> [-ViewName [<String>]] [-DoNotAlwaysShow [<SwitchParameter>]] [-ClearExisting [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
ColorTrueCalendarOverlayColor

The color to use for the overlay calendar.

OverlayListTrueSPListPipeBind

The calendar list to add as an overlay.

OverlayTitleFalseString

The title to give the overlay calendar when viewed in the target calendar.

OverlayDescriptionFalseString

The description to give the overlay calendar when viewed in the target calendar.

TargetListTrueSPListPipeBind

The calendar list to add the overlays to.

ViewNameFalseString

The name of the view to add the overlays to. If not specified the default view will be used.

DoNotAlwaysShowFalseSwitchParameter

Don't always show the calendar overlay.

ClearExistingFalseSwitchParameter

Clear existing overlays. If not specified then all overlays will be appended to the list of existing overlays (up until 10 - anything after 10 will be ignored)

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

2

ParameterRequiredTypeDescription
ColorTrueCalendarOverlayColor

The color to use for the overlay calendar.

OverlayTitleFalseString

The title to give the overlay calendar when viewed in the target calendar.

OverlayDescriptionFalseString

The description to give the overlay calendar when viewed in the target calendar.

OwaUrlTrueString

Outlook Web Access URL.

WebServiceUrlTrueString

Exchange Web Service URL.

TargetListTrueSPListPipeBind

The calendar list to add the overlays to.

ViewNameFalseString

The name of the view to add the overlays to. If not specified the default view will be used.

DoNotAlwaysShowFalseSwitchParameter

Don't always show the calendar overlay.

ClearExistingFalseSwitchParameter

Clear existing overlays. If not specified then all overlays will be appended to the list of existing overlays (up until 10 - anything after 10 will be ignored)

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

3

ParameterRequiredTypeDescription
OverlayListsTrueSPListPipeBind[]

The calendar lists to add as an overlay.

TargetListTrueSPListPipeBind

The calendar list to add the overlays to.

ViewNameFalseString

The name of the view to add the overlays to. If not specified the default view will be used.

DoNotAlwaysShowFalseSwitchParameter

Don't always show the calendar overlay.

ClearExistingFalseSwitchParameter

Clear existing overlays. If not specified then all overlays will be appended to the list of existing overlays (up until 10 - anything after 10 will be ignored)

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Detailed Description

Sets calendar overlays for the given list.

Copyright 2016 Falchion Consulting, LLC

> For more information on this cmdlet and others:

> http://blog.falchionconsulting.com/

> Use of this cmdlet is at your own risk.

> Gary Lapointe assumes no liability.

Examples

------------------EXAMPLE------------------

PS C:\> Get-SPList "http://server_name/lists/MyCalendar" | Set-SPListOverlay -TargetList "http://server_name/lists/MyOverlayCalendar" -Color "Pink" -ClearExisting

This example adds the MyOverlayCalendar calendar as an overlay to the MyCalendar list.