functions/SPClientField/New-SPClientFieldMultiLineText.ps1
|
#Requires -Version 3.0 # New-SPClientFieldMultiLineText.ps1 # # Copyright (c) 2017 karamem0 # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. function New-SPClientFieldMultiLineText { <# .SYNOPSIS Creates a new multi-line text field. .DESCRIPTION The New-SPClientFieldMultiLineText function adds a new field to the list. The field allows the user to enter multiple lines of text. .PARAMETER ClientContext Indicates the client context. If not specified, uses default context. .PARAMETER ParentList Indicates the list which a field to be created. .PARAMETER Name Indicates the internal name. .PARAMETER Title Indicates the title. .PARAMETER Identity Indicates the field GUID. .PARAMETER Description Indicates the description. .PARAMETER Required Indicates a value whether the field is required. .PARAMETER NumberOfLines Indicates the maximum number of lines. .PARAMETER RichText Indicates a value whether the field supports rich formatting. .PARAMETER DefaultValue Indicates the default value. .PARAMETER AddToDefaultView If true, the field is add to default view. .PARAMETER Retrievals Indicates the data retrieval expression. .EXAMPLE New-SPClientFieldMultiLineText $list -Name "CustomField" -Title "Custom Field" #> [CmdletBinding()] param ( [Parameter(Mandatory = $false)] [Microsoft.SharePoint.Client.ClientContext] $ClientContext = $SPClient.ClientContext, [Parameter(Mandatory = $false, Position = 0, ValueFromPipeline = $true)] [Microsoft.SharePoint.Client.List] $ParentList, [Parameter(Mandatory = $true)] [string] $Name, [Parameter(Mandatory = $false)] [string] $Title = $Name, [Parameter(Mandatory = $false)] [guid] $Identity, [Parameter(Mandatory = $false)] [string] $Description, [Parameter(Mandatory = $false)] [bool] $Required, [Parameter(Mandatory = $false)] [int] $NumberOfLines, [Parameter(Mandatory = $false)] [bool] $RichText, [Parameter(Mandatory = $false)] [string] $DefaultValue, [Parameter(Mandatory = $false)] [bool] $AddToDefaultView, [Parameter(Mandatory = $false)] [string] $Retrievals ) 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', 'Note') $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('Required')) { $FieldElement.SetAttribute('Required', $Required.ToString().ToUpper()) } if ($PSBoundParameters.ContainsKey('NumberOfLines')) { $FieldElement.SetAttribute('NumLines', $NumberOfLines) } if ($PSBoundParameters.ContainsKey('RichText')) { $FieldElement.SetAttribute('RichText', $RichText.ToString().ToUpper()) $FieldElement.SetAttribute('RichTextMode', 'FullHtml') } if ($PSBoundParameters.ContainsKey('DefaultValue')) { $DefaultElement = $XmlDocument.CreateElement('Default') $DefaultElement.InnerText = $DefaultValue $FieldElement.AppendChild($DefaultElement) | Out-Null } $AddFieldOptions = [Microsoft.SharePoint.Client.AddFieldOptions]::AddFieldInternalNameHint $ClientObject = $ParentList.Fields.AddFieldAsXml($XmlDocument.InnerXml, $AddToDefaultView, $AddFieldOptions) Invoke-SPClientLoadQuery ` -ClientContext $ClientContext ` -ClientObject $ClientObject ` -Retrievals $Retrievals $ClientObject = Convert-SPClientField ` -ClientContext $ClientContext ` -Field $ClientObject Write-Output $ClientObject } } |