functions/SPClientField/New-SPClientFieldCalculated.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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
#Requires -Version 3.0

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


function New-SPClientFieldCalculated {

<#
.SYNOPSIS
  Creates a new calclated column.
.DESCRIPTION
  The New-SPClientFieldCalculated function adds a new column to the site or list.
  The value of the column is calculated based on other columns.
.PARAMETER ClientContext
  Indicates the client context. If not specified, uses default context.
.PARAMETER ParentObject
  Indicates the site or list which a column to be created.
.PARAMETER Name
  Indicates the internal name.
.PARAMETER Title
  Indicates the title.
.PARAMETER Identity
  Indicates the column GUID.
.PARAMETER Description
  Indicates the description.
.PARAMETER Fomula
  Indicates the formula.
.PARAMETER FieldRefs
  Indicates the collection of columns which used in formula.
.PARAMETER OutputType
  Indicates the data type of the return value.
    - Text
    - Number
    - Currency
    - DateTime
    - Boolean
.PARAMETER Decimals
  Indicates the number of decimals. This parameter is used when OutputType is
  'Number' or 'Currency'.
.PARAMETER Percentage
  Indicates a value whether the column shows as percentage. This parameter is
  used when OutputType is 'Number'.
.PARAMETER LocaleId
  Indicates the language code identifier (LCID). This parameter is used when
  OutputType is 'Currency'.
.PARAMETER DateFormat
  Indicates the datetime display format. This parameter is used when OutputType
  is 'DateTime'.
.PARAMETER AddToDefaultView
  If true, the column is add to default view.
.PARAMETER Retrieval
  Indicates the data retrieval expression.
.EXAMPLE
  New-SPClientFieldCalculated $list -Name "CustomField" -Title "Custom Field" -Formula "=[Title]" -FieldRefs "Title" -OutputType "Text"
.INPUTS
  None or SPClient.SPClientFieldParentPipeBind
.OUTPUTS
  Microsoft.SharePoint.Client.FieldCalculated
.LINK
  https://github.com/karamem0/SPClient/blob/master/doc/New-SPClientFieldCalculated.md
#>


    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $false)]
        [Microsoft.SharePoint.Client.ClientContext]
        $ClientContext = $SPClient.ClientContext,
        [Parameter(Mandatory = $false, Position = 0, ValueFromPipeline = $true)]
        [SPClient.SPClientFieldParentPipeBind]
        $ParentObject,
        [Parameter(Mandatory = $true)]
        [string]
        $Name,
        [Parameter(Mandatory = $false)]
        [string]
        $Title = $Name,
        [Parameter(Mandatory = $false)]
        [guid]
        $Identity,
        [Parameter(Mandatory = $false)]
        [string]
        $Description,
        [Parameter(Mandatory = $true)]
        [string]
        $Formula,
        [Parameter(Mandatory = $true)]
        [string[]]
        $FieldRefs,
        [Parameter(Mandatory = $true)]
        [ValidateSet('Text', 'Number', 'Currency', 'DateTime', 'Boolean')]
        [string]
        $OutputType,
        [Parameter(Mandatory = $false)]
        [int]
        $Decimals,
        [Parameter(Mandatory = $false)]
        [bool]
        $Percentage,
        [Parameter(Mandatory = $false)]
        [int]
        $LocaleId,
        [Parameter(Mandatory = $false)]
        [ValidateSet('DateOnly', 'DateTime')]
        [string]
        $DateFormat,
        [Parameter(Mandatory = $false)]
        [bool]
        $AddToDefaultView,
        [Parameter(Mandatory = $false)]
        [string]
        $Retrieval
    )

    process {
        if ($ClientContext -eq $null) {
            throw "Cannot bind argument to parameter 'ClientContext' because it is null."
        }
        $XmlDocument = New-Object System.Xml.XmlDocument
        $FieldElement = $XmlDocument.AppendChild($XmlDocument.CreateElement('Field'))
        $FieldElement.SetAttribute('Type', 'Calculated')
        $FieldElement.SetAttribute('ReadOnly', 'TRUE')
        $FieldElement.SetAttribute('Name', $Name)
        $FieldElement.SetAttribute('DisplayName', $Title)
        if ($PSBoundParameters.ContainsKey('Identity')) {
            $FieldElement.SetAttribute('ID', $Identity)
        }
        if ($PSBoundParameters.ContainsKey('Description')) {
            $FieldElement.SetAttribute('Description', $Description)
        }
        if ($PSBoundParameters.ContainsKey('Formula')) {
            $FormulaElement = $FieldElement.AppendChild($XmlDocument.CreateElement('Formula'))
            $FormulaElement.InnerText = $Formula
        }
        if ($PSBoundParameters.ContainsKey('FieldRefs')) {
            $FieldRefsElement = $FieldElement.AppendChild($XmlDocument.CreateElement('FieldRefs'))
            foreach ($FieldRef in $FieldRefs) {
                $FieldRefElement = $FieldRefsElement.AppendChild($XmlDocument.CreateElement('FieldRef'))
                $FieldRefElement.SetAttribute('Name', $FieldRef)
            }
        }
        if ($PSBoundParameters.ContainsKey('OutputType')) {
            $FieldElement.SetAttribute('ResultType', $OutputType)
        }
        if ($PSBoundParameters.ContainsKey('Decimals')) {
            $FieldElement.SetAttribute('Decimals', $Decimals)
        }
        if ($PSBoundParameters.ContainsKey('Percentage')) {
            $FieldElement.SetAttribute('Percentage', $Percentage.ToString().ToUpper())
        }
        if ($PSBoundParameters.ContainsKey('LocaleId')) {
            $FieldElement.SetAttribute('LCID', $LocaleId)
        }
        if ($PSBoundParameters.ContainsKey('DateFormat')) {
            $FieldElement.SetAttribute('Format', $DateFormat)
        }
        $AddFieldOptions = [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint
        $ClientObject = $ParentObject.ClientObject.Fields.AddFieldAsXml($XmlDocument.InnerXml, $AddToDefaultView, $AddFieldOptions)
        $ClientObject = Convert-SPClientField `
            -ClientContext $ClientContext `
            -Field $ClientObject
        Invoke-ClientContextLoad `
            -ClientContext $ClientContext `
            -ClientObject $ClientObject `
            -Retrieval $Retrieval
        Write-Output $ClientObject
    }

}