functions/SPClientContentType/Remove-SPClientContentTypeField.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
#Requires -Version 3.0

<#
  Remove-SPClientContentTypeField.ps1
 
  Copyright (c) 2017 karamem0
 
  This software is released under the MIT License.
  https://github.com/karamem0/SPClient/blob/master/LICENSE
#>


function Remove-SPClientContentTypeField {


<#
.SYNOPSIS
  Removes a column from the content type.
.DESCRIPTION
  The Remove-SPClientContentTypeField function removes a column to the specified content type.
.PARAMETER ClientContext
  Indicates the client context. If not specified, uses default context.
.PARAMETER ContentType
  Indicates the content type.
.PARAMETER Field
  Indicates the column to remove.
.PARAMETER UpdateChildren
  If specified, updates all content types that inherit from the content type.
.PARAMETER PassThru
  If specified, returns the content type.
.EXAMPLE
  Remove-SPClientContentTypeField $contentType -Field $field -UpdateChildren
.INPUTS
  None or Microsoft.SharePoint.Client.ContentType
.OUTPUTS
  None or Microsoft.SharePoint.Client.ContentType
.LINK
  https://github.com/karamem0/SPClient/blob/master/doc/Remove-SPClientContentTypeField.md
#>


    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $false)]
        [Microsoft.SharePoint.Client.ClientContext]
        $ClientContext = $SPClient.ClientContext,
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
        [Microsoft.SharePoint.Client.ContentType]
        $ContentType,
        [Parameter(Mandatory = $true)]
        [Microsoft.SharePoint.Client.Field]
        $Field,
        [Parameter(Mandatory = $false)]
        [switch]
        $UpdateChildren,
        [Parameter(Mandatory = $false)]
        [switch]
        $PassThru
    )

    process {
        if ($ClientContext -eq $null) {
            throw "Cannot bind argument to parameter 'ClientContext' because it is null."
        }
        if (-not $ContentType.IsPropertyAvailable('Id')) {
            Invoke-ClientContextLoad `
                -ClientContext $ClientContext `
                -ClientObject $ContentType `
                -Retrieval 'Id'
        }
        if (-not $Field.IsPropertyAvailable('Id')) {
            Invoke-ClientContextLoad `
                -ClientContext $ClientContext `
                -ClientObject $Field `
                -Retrieval 'Id'
        }
        $FieldLinkCollection = $ContentType.FieldLinks
        Invoke-ClientContextLoad `
            -ClientContext $ClientContext `
            -ClientObject $FieldLinkCollection `
            -Retrieval 'Id'
        $FieldLink = $FieldLinkCollection | Where-Object { $_.Id -eq $Field.Id }
        if ($FieldLink -eq $null) {
            throw 'The specified field could not be found.'
        }
        $FieldLink.DeleteObject()
        $ContentType.Update($UpdateChildren)
        $ClientContext.ExecuteQuery()
        if ($PassThru) {
            Write-Output $ContentType
        }
    }

}