SharePoint - Client Side Object Model(CSOM) - Managed - Get List Fields

-

Problem Definition

Retrieve List fields with details using Managed Code and Client Side Object Model(CSOM) for SharePoint 2013.

Prerequisites


Code Example



/// <summary>
/// Print list field names
/// </summary>
/// <param name="listTitle"> List Title </param>
public static void GetFields(string listTitle)
{
            //var spContext = new ClientContext("http://<your server>/<site>/");
            using (spContext)
            {
                // Client side SP Web Conext
                var webContext = spContext.Web;
                // Initilize web and load web object
                spContext.Load(webContext);
                // Get list details by list title
                var list = webContext.Lists.GetByTitle(listTitle);
                // Initilize and load lists fields
                spContext.Load(list.Fields);
                // Execute the query, which in this case will retrieve the fields
                spContext.ExecuteQuery();
                // Print the Count of Fields
                Console.WriteLine($"Columns Found: {list.Fields.Count}");
                // Print the Details with Header
                Console.WriteLine("{0}   {1}   {2}   {3}"
                    , "Title".PadRight(30)
                    , "InternalName".PadRight(26)
                    , "Hidden".PadRight(7)
                    , "Del?");
                Console.WriteLine("--------------------------------------------------------------------------------");
                // Sort results by hidden field value
                var sortedList = list.Fields.ToList().OrderBy(x => x.Hidden);
                foreach (Field f in sortedList)
                {
                    Console.WriteLine("{0} | {1} | {2} | {3}"
                        , f.Title.PadRight(30)
                        , f.InternalName.PadRight(26)
                        , (f.Hidden ? "Hidden" : "Visible").PadRight(7)
                        , f.CanBeDeleted.ToString().PadRight(3));
                }
            }
}


------------------------------------------Alternative Syntax(Same Result)----------------------------------------
 /// <summary>
/// Print list field names
/// </summary>
/// <param name="listTitle"> List Title </param>
public static void GetFields_Syntax2(string listTitle)
{
            //var spContext = new ClientContext("http://<your server>/<site>/");
            using (spContext)
            {
                // Client side SP Web Conext
                var web = spContext.Web;
                // Initilize web and load web object
                spContext.Load(web);
                //Get List by Title              
                var list = web.Lists.GetByTitle(listTitle);
                //Cherry Pick fields to include
                spContext.Load(list,
                    l => l.Title
                    ,l=>l.Fields.Include(f => f.Title
                ,f=>f.InternalName
                , f => f.Hidden
                , f => f.CanBeDeleted));
                //Execute
                spContext.ExecuteQuery();
                // Print the Count of Fields
                Console.WriteLine($"Columns Found: {list.Fields.Count}");
                // Print the Details with Header
                Console.WriteLine("{0}   {1}   {2}   {3}"
                    , "Title".PadRight(30)
                    , "InternalName".PadRight(26)
                    , "Hidden".PadRight(7)
                    , "Del?");
                Console.WriteLine("--------------------------------------------------------------------------------");
                // Sort results by hidden field value
                var sortedList = list.Fields.ToList().OrderBy(x => x.Hidden);
                foreach (Field f in sortedList)
                {
                    Console.WriteLine("{0} | {1} | {2} | {3}"
                        , f.Title.PadRight(30)
                        , f.InternalName.PadRight(26)
                        , (f.Hidden ? "Hidden" : "Visible").PadRight(7)
                        , f.CanBeDeleted.ToString().PadRight(3));
                }
            }
}

----------------------------------------LINQ Query Syntax(Same Result)----------------------------------------

/// <summary>
/// Print list field names
/// </summary>
/// <param name="listTitle"> List Title </param>
public static void GetFields_LinqSyntax(string listTitle)
{
            //var spContext = new ClientContext("http://<your server>/<site>/");
            using (spContext)
            {
                // Client side SP Web Conext
                var web = spContext.Web;
                // Initilize web and load web object
                spContext.Load(web);
                //Get List by Title              
                var list = web.Lists.GetByTitle(listTitle);
                //Cherry Pick fields to include using a linq Query
                var query = from fl in list.Fields.Include(f => f.Title
                 , f => f.InternalName
                 , f => f.Hidden
                 , f => f.CanBeDeleted)
                 select fl;
                //Load the linq query
                var fields = spContext.LoadQuery(query);
                //Execute query
                spContext.ExecuteQuery();
                // Print the Count of Fields
                Console.WriteLine($"Columns Found: {fields.Count()}");
                // Print the Details with Header
                Console.WriteLine("{0}   {1}   {2}   {3}"
                    , "Title".PadRight(30)
                    , "InternalName".PadRight(26)
                    , "Hidden".PadRight(7)
                    , "Del?");
                Console.WriteLine("--------------------------------------------------------------------------------");
                // Sort results by hidden field value
                var sortedList = fields.ToList().OrderBy(x => x.Hidden);
                foreach (Field f in sortedList)
                {
                    Console.WriteLine("{0} | {1} | {2} | {3}"
                        , f.Title.PadRight(30)
                        , f.InternalName.PadRight(26)
                        , (f.Hidden ? "Hidden" : "Visible").PadRight(7)
                        , f.CanBeDeleted.ToString().PadRight(3));
                }
            }
 }

Code Result




Comments

Post a Comment

Popular posts from this blog

Azure - Manage Blob Storage - Part #7 - Add Metadata to an Existing Container using C#

-
Image
Problem Definition How to add Metadata to and Existing container using C# in Azure. Prerequisites Access to Azure Portal -  http://portal.azure.com Azure General Purpose Storage Account Microsoft Visual Studio(For this demo used Visual Studio Community for Mac) Storage Account connection string as described in  Part #1 Complete Visual studio connectivity to Azure as described in  Part #1 Create a blob container as described in in  Part #2 Use following code to set up a new method in your class "BlobStorageContainer.cs" CloudBlobContainer will use the name that was passed to check if container exists or not. For block blob to be created container should be existing refer to  Part #2  to see how to create the container. How to call from "Program.cs" Results Program execution Azure confirmation Resources https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-bl...
Read more

Azure - Manage Blob Storage - Part #5 - Create Folder Structure and upload a file to folder using an Existing Container using C#

-
Image
Problem Definition How to create directory structure and files using C# in Azure. Prerequisites Access to Azure Portal -  http://portal.azure.com Azure General Purpose Storage Account Microsoft Visual Studio(For this demo used Visual Studio Community for Mac) Storage Account connection string as described in  Part #1 Complete Visual studio connectivity to Azure as described in  Part #1 Create a blob container as described in in  Part #2 Use following code to set up a new method in your class "BlobStorageContainer.cs" CloudBlobContainer will use the name that was passed to check if container exists or not. For block blob to be created container should be existing refer to  Part #2  to see how to create the container. How to call from "Program.cs" Results Program execution Azure confirmation Resources https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-dotn...
Read more

Algorithm - Breadth First Search(BFS) - Python(3)

-
Problem Definition Understand and implement BFS in Python Breadth-first search (BFS) is an algorithm for traversing or searching tree or graph data structures. It starts at the tree root (or some arbitrary node of a graph, sometimes referred to as a 'search key'[1]), and explores all of the neighbor nodes at the present depth prior to moving on to the nodes at the next depth level. Python Code graph = {   '1' : ['2','3'],   '2' : ['4', '5'],   '3' : ['6'],   '4' : ['7'],   '5' : ['6'],   '6' : [],   '7' : ['8'],   '8' : [] } queued_nodes = []   visited_nodes = []  def bfs(visited_nodes, graph, node):   print ("Following represent graph traverse for node: " + node)   visited_nodes.append(node)   queued_nodes.append(node)     while queued_nodes:     q = queued_nodes.pop(0)      print (q, end = " ")      for neighbour_node in graph[q]:...
Read more