Get All The Site Groups in SharePoint 2010 Using ECMAScript

Introduction

In this article you will see how to get all the site groups in SharePoint 2010 using ECMAScript. I have the following site groups from which I need to get the group name (Navigate to the site, click on Site Actions. Click on Site Settings. In the Users and Permissions section, click on People and Groups. In the left pane, click on Groups).



Steps Involved

1. Navigate to the SharePoint site (I have a site page created in my site where I am going to add the content editor web part).
2. Go to Site Actions, click on Edit Page.
   
   
    
3. Click on Insert tab in the ribbon interface and then click on Web Part button.
   
   
    
4. Select Media and Content in the Categories section and then click on Content Editor.
   
   
    
5. Click on Add.
6. A Content editor web part will be added to the site page.
7. Click on the down arrow and then click on Edit Web Part.
   
   
    
8. Click on "Click here to add new content".
   
   
    
9. Click on Format Text tab in the ribbon interface and then click on HTML drop down.
   
   
    
10. Click on Edit HTML source.
11. HTML source window will pop up.
    
    
     
12. Copy and paste the following script.
    
    <script language="ecmascript" type="text/ecmascript">

            var groupCollection;

            function getSiteGroups() {

                var clientContext = new SP.ClientContext();
                this.groupCollection = clientContext.get_web().get_siteGroups();
                clientContext.load(groupCollection);
                clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));

            }

            function onQuerySucceeded() {
                var groupName = 'Site Groups: \n';
                var groupsEnumerator = this.groupCollection.getEnumerator();
                while (groupsEnumerator.moveNext()) {
                    var group = groupsEnumerator.get_current();
                    groupName += group.get_title() + '\n';
                }
                alert(groupName);
            }

            function onQueryFailed(sender, args) {
                alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
            }</script>
        <input id="btnGetSiteGroups" onclick="getSiteGroups()" type="button" value="Get Site Groups" />
    
     

13. Click on Ok.
14. In the ribbon interface click on Save & Close button.
    
    
     
15. In the content editor web part you should find a button named "Get Site Groups", click on that button.
    
    
     
16. An alert will pop up displaying all the site groups as shown in the following.
    
    
    

Reference

SP.Web.siteGroups Property - http://msdn.microsoft.com/en-us/library/ee554059.aspx

Summary

Thus in this article you have seen how to get all the site groups in SharePoint 2010 using ECMAScript.