Added ContentType and Field completers

erwinvanhunen · erwinvanhunen · commit 659cf948f91f · 2024-11-13T10:50:30.000+01:00
diff --git a/src/Commands/Base/Completers/ContentTypeCompleter.cs b/src/Commands/Base/Completers/ContentTypeCompleter.cs
@@ -0,0 +1,25 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using System.Management.Automation;
+using System.Management.Automation.Language;
+using System.Reflection.Metadata;
+using Microsoft.SharePoint.Client;
+
+namespace PnP.PowerShell.Commands.Base.Completers
+{
+    public sealed class ContentTypeCompleter : IArgumentCompleter
+    {
+        public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        {
+            IEnumerable<ContentType> result = PnPConnection.Current.Context.LoadQuery(PnPConnection.Current.Context.Web.AvailableContentTypes.Include(f => f.Name));
+            PnPConnection.Current.Context.ExecuteQueryRetry();
+            foreach (var ct in result.Where(l => l.Name.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))
+            {
+                var ctName = ct.Name.IndexOf(" ") > 0? $"'{ct.Name}'" : ct.Name;
+                yield return new CompletionResult(ctName);
+            }
+        }
+    }
+}
diff --git a/src/Commands/Base/Completers/FieldInternalNameCompleter.cs b/src/Commands/Base/Completers/FieldInternalNameCompleter.cs
@@ -0,0 +1,24 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using System.Management.Automation;
+using System.Management.Automation.Language;
+using System.Reflection.Metadata;
+using Microsoft.SharePoint.Client;
+
+namespace PnP.PowerShell.Commands.Base.Completers
+{
+    public sealed class FieldInternalNameCompleter : IArgumentCompleter
+    {
+        public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        {
+            IEnumerable<Field> result = PnPConnection.Current.Context.LoadQuery(PnPConnection.Current.Context.Web.AvailableFields.Include(f => f.InternalName));
+            PnPConnection.Current.Context.ExecuteQueryRetry();
+            foreach (var field in result.Where(l => l.InternalName.StartsWith(wordToComplete, StringComparison.InvariantCultureIgnoreCase)))
+            {
+                yield return new CompletionResult(field.InternalName);
+            }
+        }
+    }
+}
diff --git a/src/Commands/ContentTypes/AddContentTypeToList.cs b/src/Commands/ContentTypes/AddContentTypeToList.cs
@@ -14,6 +14,7 @@ public class AddContentTypeToList : PnPWebCmdlet
 
         [Parameter(Mandatory = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind ContentType;
 
         [Parameter(Mandatory = false)]
diff --git a/src/Commands/ContentTypes/AddFieldToContentType.cs b/src/Commands/ContentTypes/AddFieldToContentType.cs
@@ -1,7 +1,7 @@
 ﻿using System;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
-
+using PnP.PowerShell.Commands.Base.Completers;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 
 namespace PnP.PowerShell.Commands.ContentTypes
@@ -10,10 +10,12 @@ namespace PnP.PowerShell.Commands.ContentTypes
     public class AddFieldToContentType : PnPWebCmdlet
     {
         [Parameter(Mandatory = true)]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Field;
 
         [Parameter(Mandatory = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind ContentType;
 
         [Parameter(Mandatory = false)]
diff --git a/src/Commands/ContentTypes/GetContentType.cs b/src/Commands/ContentTypes/GetContentType.cs
@@ -17,6 +17,7 @@ public class GetContentType : PnPWebRetrievalsCmdlet<ContentType>
     {
         [Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true)]
         [ValidateNotNullOrEmpty]
+         [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind Identity;
 
         [Parameter(Mandatory = false, ValueFromPipeline = true)]
diff --git a/src/Commands/ContentTypes/GetContentTypePublishingStatus.cs b/src/Commands/ContentTypes/GetContentTypePublishingStatus.cs
@@ -1,7 +1,7 @@
 using System;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
-
+using PnP.PowerShell.Commands.Base.Completers;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 
 namespace PnP.PowerShell.Commands.ContentTypes
@@ -11,6 +11,7 @@ public class GetContentTypePublishingStatus : PnPWebCmdlet
     {
         [Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind ContentType;
 
         protected override void ExecuteCmdlet()
@@ -20,7 +21,7 @@ protected override void ExecuteCmdlet()
             ClientContext.Load(pub);
             ClientContext.ExecuteQueryRetry();
             var ct = ContentType.GetContentTypeOrError(this, nameof(ContentType), site.RootWeb);
-            
+
             if (ct == null)
             {
                 WriteError(new ErrorRecord(new Exception($"Invalid content type id."), "INVALIDCTID", ErrorCategory.InvalidArgument, ContentType));
diff --git a/src/Commands/ContentTypes/PublishContentType.cs b/src/Commands/ContentTypes/PublishContentType.cs
@@ -1,7 +1,7 @@
 using System;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
-
+using PnP.PowerShell.Commands.Base.Completers;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 
 namespace PnP.PowerShell.Commands.ContentTypes
@@ -11,6 +11,7 @@ public class PublishContentType : PnPWebCmdlet
     {
         [Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind ContentType;
 
         protected override void ExecuteCmdlet()
diff --git a/src/Commands/ContentTypes/RemoveContentType.cs b/src/Commands/ContentTypes/RemoveContentType.cs
@@ -1,4 +1,5 @@
-﻿using PnP.PowerShell.Commands.Base.PipeBinds;
+﻿using PnP.PowerShell.Commands.Base.Completers;
+using PnP.PowerShell.Commands.Base.PipeBinds;
 using System.Management.Automation;
 using Resources = PnP.PowerShell.Commands.Properties.Resources;
 
@@ -8,14 +9,16 @@ namespace PnP.PowerShell.Commands.ContentTypes
     public class RemoveContentType : PnPWebCmdlet
     {
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true)]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind Identity;
 
+
         [Parameter(Mandatory = false)]
         public SwitchParameter Force;
 
         protected override void ExecuteCmdlet()
         {
-            var ct = Identity?.GetContentTypeOrThrow(nameof(Identity), Connection.PnPContext);            
+            var ct = Identity?.GetContentTypeOrThrow(nameof(Identity), Connection.PnPContext);
             if (Force || ShouldContinue($"Remove Content Type '{ct.Name}'?", Resources.Confirm))
             {
                 ct.Delete();
diff --git a/src/Commands/ContentTypes/RemoveContentTypeFromList.cs b/src/Commands/ContentTypes/RemoveContentTypeFromList.cs
@@ -14,6 +14,7 @@ public class RemoveContentTypeFromList : PnPWebCmdlet
 
         [Parameter(Mandatory = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind ContentType;
 
         protected override void ExecuteCmdlet()
diff --git a/src/Commands/ContentTypes/RemoveFieldFromContentType.cs b/src/Commands/ContentTypes/RemoveFieldFromContentType.cs
@@ -2,7 +2,7 @@
 using System.Linq;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
-
+using PnP.PowerShell.Commands.Base.Completers;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 
 namespace PnP.PowerShell.Commands.ContentTypes
@@ -12,10 +12,12 @@ public class RemoveFieldFromContentType : PnPWebCmdlet
     {
         [Parameter(Mandatory = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Field;
 
         [Parameter(Mandatory = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind ContentType;
 
         [Parameter(Mandatory = false)]
@@ -45,15 +47,15 @@ protected override void ExecuteCmdlet()
                     field = null;
                 }
             }
-            
+
             if (field is null)
             {
                 throw new PSArgumentException("Field not found", nameof(Field));
             }
-            
+
             var ct = ContentType.GetContentTypeOrThrow(nameof(ContentType), CurrentWeb, true);
             ct.EnsureProperty(c => c.FieldLinks);
-            
+
             var fieldLink = ct.FieldLinks.FirstOrDefault(f => f.Id == field.Id);
             if (fieldLink is null)
             {
diff --git a/src/Commands/ContentTypes/SetContentType.cs b/src/Commands/ContentTypes/SetContentType.cs
@@ -13,6 +13,7 @@ public class SetContentType : PnPWebCmdlet
 
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_FormCustomizersConvenienceParams)]
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_FormCustomizersParams)]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind Identity;
 
         [Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ParameterSet_FormCustomizersConvenienceParams)]
@@ -185,7 +186,7 @@ protected override void ExecuteCmdlet()
 
                 if (updateRequired)
                 {
-                    if(list != null)
+                    if (list != null)
                     {
                         WriteVerbose("Updating content type on list");
                         ct.Update(false);
diff --git a/src/Commands/ContentTypes/SetDefaultContentTypeToList.cs b/src/Commands/ContentTypes/SetDefaultContentTypeToList.cs
@@ -15,6 +15,7 @@ public class SetDefaultContentTypeToList : PnPWebCmdlet
 
         [Parameter(Mandatory = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind ContentType;
 
         protected override void ExecuteCmdlet()
diff --git a/src/Commands/ContentTypes/UnpublishContentType.cs b/src/Commands/ContentTypes/UnpublishContentType.cs
@@ -1,7 +1,7 @@
 using System;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
-
+using PnP.PowerShell.Commands.Base.Completers;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 
 namespace PnP.PowerShell.Commands.ContentTypes
@@ -11,6 +11,7 @@ public class UnpublishContentType : PnPWebCmdlet
     {
         [Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true)]
         [ValidateNotNullOrEmpty]
+        [ArgumentCompleter(typeof(ContentTypeCompleter))]
         public ContentTypePipeBind ContentType;
         protected override void ExecuteCmdlet()
         {
@@ -19,7 +20,7 @@ protected override void ExecuteCmdlet()
             ClientContext.Load(pub);
             ClientContext.ExecuteQueryRetry();
             var ct = ContentType.GetContentTypeOrError(this, nameof(ContentType), site.RootWeb);
-            
+
             if (ct == null)
             {
                 WriteError(new ErrorRecord(new Exception($"Invalid content type id."), "INVALIDCTID", ErrorCategory.InvalidArgument, ContentType));
diff --git a/src/Commands/DocumentSets/SetDocumentSetField.cs b/src/Commands/DocumentSets/SetDocumentSetField.cs
@@ -2,7 +2,7 @@
 using System.Linq;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
-
+using PnP.PowerShell.Commands.Base.Completers;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 
 namespace PnP.PowerShell.Commands.DocumentSets
@@ -15,7 +15,8 @@ public class SetFieldInDocumentSet : PnPWebCmdlet
         public DocumentSetPipeBind DocumentSet;
 
         [Parameter(Mandatory = true)]
-        public FieldPipeBind Field; 
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
+        public FieldPipeBind Field;
 
         [Parameter(Mandatory = false)]
         public SwitchParameter SetSharedField;
@@ -41,9 +42,9 @@ protected override void ExecuteCmdlet()
                 WriteWarning("Cannot set and remove a welcome page field at the same time");
                 return;
             }
-         
+
             var docSetTemplate = DocumentSet.GetDocumentSetTemplate(CurrentWeb);
-            
+
 
             ClientContext.Load(docSetTemplate, dt => dt.AllowedContentTypes, dt => dt.SharedFields, dt => dt.WelcomePageFields);
             ClientContext.ExecuteQueryRetry();
diff --git a/src/Commands/Fields/AddField.cs b/src/Commands/Fields/AddField.cs
@@ -24,6 +24,7 @@ public class AddField : PnPWebCmdlet, IDynamicParameters
         public ListPipeBind List;
 
         [Parameter(Mandatory = true, ParameterSetName = ParameterSet_ADDFIELDREFERENCETOLIST)]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Field;
 
         [Parameter(Mandatory = true, ParameterSetName = ParameterSet_ADDFIELDTOLIST)]
diff --git a/src/Commands/Fields/GetField.cs b/src/Commands/Fields/GetField.cs
@@ -17,6 +17,7 @@ public class GetField : PnPWebRetrievalsCmdlet<Field>
         public ListPipeBind List;
 
         [Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true)]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Identity = new FieldPipeBind();
 
         [Parameter(Mandatory = false)]
diff --git a/src/Commands/Fields/RemoveField.cs b/src/Commands/Fields/RemoveField.cs
@@ -15,6 +15,7 @@ namespace PnP.PowerShell.Commands.Fields
     public class RemoveField : PnPWebCmdlet
     {
         [Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0)]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Identity = new FieldPipeBind();
 
         [Parameter(Mandatory = false, ValueFromPipeline = true, Position = 1)]
diff --git a/src/Commands/Fields/SetField.cs b/src/Commands/Fields/SetField.cs
@@ -17,6 +17,7 @@ public class SetField : PnPWebCmdlet
         public ListPipeBind List;
 
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true)]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Identity = new FieldPipeBind();
 
         [Parameter(Mandatory = false)]
diff --git a/src/Commands/Lists/ClearDefaultColumnValues.cs b/src/Commands/Lists/ClearDefaultColumnValues.cs
@@ -19,6 +19,7 @@ public class ClearDefaultColumnValues : PnPWebCmdlet
         public ListPipeBind List;
 
         [Parameter(Mandatory = true)]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Field;
 
         [Parameter(Mandatory = false)]
diff --git a/src/Commands/Lists/SetDefaultColumnValues.cs b/src/Commands/Lists/SetDefaultColumnValues.cs
@@ -17,6 +17,7 @@ public class SetDefaultColumnValues : PnPWebCmdlet
         public ListPipeBind List;
 
         [Parameter(Mandatory = true)]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Field;
 
         [Parameter(Mandatory = true)]
diff --git a/src/Commands/Lists/SetImageListItem.cs b/src/Commands/Lists/SetImageListItem.cs
@@ -27,6 +27,7 @@ public class ImageListItemColumn : PnPWebCmdlet
 
         [Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = ParameterSet_ASServerRelativeUrl)]
         [Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = ParameterSet_ASPath)]
+        [ArgumentCompleter(typeof(FieldInternalNameCompleter))]
         public FieldPipeBind Field = new FieldPipeBind();
 
         [Parameter(Mandatory = true, ParameterSetName = ParameterSet_ASServerRelativeUrl)]

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ public class GetContentType : PnPWebRetrievalsCmdlet<ContentType>`
`17`	`17`	`{`
`18`	`18`	`[Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true)]`
`19`	`19`	`[ValidateNotNullOrEmpty]`
	`20`	`+ [ArgumentCompleter(typeof(ContentTypeCompleter))]`
`20`	`21`	`public ContentTypePipeBind Identity;`
`21`	`22`
`22`	`23`	`[Parameter(Mandatory = false, ValueFromPipeline = true)]`