Skip to content

Latest commit

 

History

History
140 lines (105 loc) · 3.46 KB

Set-PnPDocumentSetField.md

File metadata and controls

140 lines (105 loc) · 3.46 KB
Raw
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Set-PnPDocumentSetField

SYNOPSIS

Sets a site column from the available content types to a document set

SYNTAX

Set-PnPDocumentSetField -DocumentSet <DocumentSetPipeBind>
                        -Field <FieldPipeBind>
                        [-SetSharedField [<SwitchParameter>]]
                        [-SetWelcomePageField [<SwitchParameter>]]
                        [-RemoveSharedField [<SwitchParameter>]]
                        [-RemoveWelcomePageField [<SwitchParameter>]]
                        [-Web <WebPipeBind>]
                        [-Connection <SPOnlineConnection>]

EXAMPLES

------------------EXAMPLE 1------------------

PS:> Set-PnPDocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -SetSharedField -SetWelcomePageField

This will set the field, available in one of the available content types, as a Shared Field and as a Welcome Page Field.

------------------EXAMPLE 2------------------

PS:> Set-PnPDocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -RemoveSharedField -RemoveWelcomePageField

This will remove the field, available in one of the available content types, as a Shared Field and as a Welcome Page Field.

PARAMETERS

-DocumentSet

The document set in which to set the field. Either specify a name, a document set template object, an id, or a content type object

Type: DocumentSetPipeBind
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-Field

The field to set. The field needs to be available in one of the available content types. Either specify a name, an id or a field object

Type: FieldPipeBind
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-RemoveSharedField

Removes the field as a Shared Field

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-RemoveWelcomePageField

Removes the field as a Welcome Page Field

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SetSharedField

Set the field as a Shared Field

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-SetWelcomePageField

Set the field as a Welcome Page field

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices