Skip to main content

Step by Step guide to create a Client App Part in SharePoint Hosted Development Environment.

I think you already know about hosted approaches in SharePoint 2013. There are three types of hosted approaches (SharePoint-Hosted, Provider-Hosted, Auto-Hosted).  Though there are similarities as well as differences. Thus there are slightly differences in developing client app part in SharePoint Hosted Model.   
This is Step by Step Guide to Create a Client App part.
  • Create a Visual Studio Project by specifying SharePoint Hosted option.
    image
  • Then Visual Studio will create a project for you.
    image
( If you looked closely you can find out it is referring jQuery 1.6.2 version that is quite old. So if you want you can right click the project and go to NuGet Manager and install new version. )
  • Now we are going to add a Client App part. Client App Apart is concept which allows to run SharePoint pages inside the iFrame. Therefore you can theoretically display any page inside the client app part.
  • As a guide I will show two types of Client App Parts.
    • Simple App Part
    • App Part with SharePoint
    I separated these two of JavaScript usage. Most of the online sources talk about the simple app part but when you try to use it with “SP.ClientContext” ; it is giving errors.
Simple App Part
  • Adding a client web part is same  for both types. You need to right click the project and add a Client Web part with a desired name.
image
  • When you and you will get a Client App Part with a element.xml
image
  • Element.xml is used for specifying rendering width, height,  what page to point and define client app part properties (if any)
  • Now we need a page to point in the client app part. Thus I'm creating folder under pages called AppPart (This is just for easiness you can put the page inside the page folder as well) and creating a page called Page.aspx
image
  • The page comes with two content place holders which is pointed to SharePoint master page. If you use this one your app part pages will have SharePoint master page simply ribbon and all. since we are placing client app part inside a page we do not want ribbon and staffs in it. Thus delete the entire content in the page.
  •   and put following code to the page.
<%@ Page Inherits="Microsoft.SharePoint.WebPartPages.WebPartPage, Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" Language="C#" %>
 
<%@ Register TagPrefix="SharePoint" Namespace="Microsoft.SharePoint.WebControls" Assembly="Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register TagPrefix="Utilities" Namespace="Microsoft.SharePoint.Utilities" Assembly="Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register TagPrefix="WebPartPages" Namespace="Microsoft.SharePoint.WebPartPages" Assembly="Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
 
<!-- The following tells SharePoint to allow this page to be hosted in an IFrame -->
<WebPartPages:AllowFraming runat="server" />
 
<html>
<head></head>
<body >
    <div>Simple Client App Part</div>
</body>
</html>



  • <WebPartPages:AllowFraming runat="server" /> this tag allows to page to run as a ifame. In the Url also DisplayType=iframe allows to render like a iframe. You do not need to put both of them I just illustrate it for reference.
  • Now you are ready with the page. you need to give the page path to client app part. thus you need to open the Element.xml in the client app and put the url there.

image

    <Content Type="html" Src="~appWebUrl/Pages/AppPart/Simple.aspx?DisplayType=iframe" />


  • When adding the url you need to use ~appweburl as a prefix to resolve the web url.
  • Now you can deploy app to the SharePoint and see whether it is working.

image

App Part with SharePoint



  • If you are going to use SharePoint Client Context in side your Client app page refer following  JavaScripts as well. (mQuery,sp.ui.dialog,callout is commented because it may not need for you all the time)


<%@ Page Inherits="Microsoft.SharePoint.WebPartPages.WebPartPage, Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" Language="C#" %>

<%@ Register TagPrefix="SharePoint" Namespace="Microsoft.SharePoint.WebControls" Assembly="Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register TagPrefix="Utilities" Namespace="Microsoft.SharePoint.Utilities" Assembly="Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register TagPrefix="WebPartPages" Namespace="Microsoft.SharePoint.WebPartPages" Assembly="Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>

<!-- The following tells SharePoint to allow this page to be hosted in an IFrame -->
<WebPartPages:AllowFraming runat="server" />

<html>
<head>
    <!-- Add your CSS styles to the following file -->

    <link href="../../Content/App.css" rel="stylesheet" />
    <script src="../../Scripts/jquery-1.6.2.min.js"></script>

    <script type="text/javascript" src="https://ajax.aspnetcdn.com/ajax/4.0/1/MicrosoftAjax.js"></script>
    <script type="text/javascript" src="/_layouts/15/init.js"></script>
     <%--<script type="text/javascript" src="/_layouts/15/mQuery.js"></script>
    <script type="text/javascript" src="/_layouts/15/sp.ui.dialog.js"></script>--%>
    <script type="text/javascript" src="/_layouts/15/sp.runtime.js"></script>
    <script type="text/javascript" src="/_layouts/15/sp.js"></script>
    <%--<script type="text/javascript" src="/_layouts/15/callout.js"></script>--%>

    <script src="../../Scripts/App.js"></script> <%--/Yon can write your js here/--%>
    

    <script type="text/javascript">
        $(document).ready(function () {
            SP.SOD.executeFunc('sp.js', 'SP.ClientContext', function () {
                // sharePointReady(); Any Code
                
            });
        });
    </script>
</head>

<body>
 
</body>
</html>



Comments

Popular posts from this blog

How to Link Two List and Create a combine view in the SharePoint 2010

In this way you can join multiple list together and can create a combine view. for an example assume that you are managing a list for some events. And also you are having a participants in separate list. Thus you want to join the two list and create a composite view. SharePoint 2010 allows you to create this kind of view using  Linked Data Source. in this approach you can create your own custom list in the SharePoint. How to Create a Linked Data source Go to SharePoint designer and  go to the link called data sources. And Click the Linked Data Source button in the ribbon. Then SharePoint designer will prompt following kind of a dialog. In there add two list, that you wan to linked together. I'm adding airline schedule and booking list. those are the two list that i wan to merge. then click next. And it will guide you another screen. it will ask you to select either Merge Merge use to combine list which are having same columns definition. for and example we can s...

The content database has a schema version which is not supported this version

How to copy you production SharePoint  database to development environment. I had my production environment as SharePoint 2013 SQL Server 2012 and I want to move the instance to another environment , which is freshly installed and different environment and different KBs Share Point 2013 SQL Server 2016 How to migrate SharePoint 2013 , SQL Server 2012 Content Database to SharePoint 2013 SQL Server 2016. Method 1. This is a general method, which is used for upgrading your content database. 1 . Get the back up of the current Content Database 2. Copy SQL backup to new environment 3. Restore the SQL Back Up in to the new environment 4. Go to the Security Login section and grant permission to content database for existing SharePoint Users.   5. You need to select the User mapping and DBO for the content database. 6 Then, execute below PS in SharePoint PowerShell. Make sure you executed as Run as Administrator 7 Firstly, You need to Update the content database. 8. then, mount the usi...

How to set Current User Name to InfoPath Person/Group Picker

This method also use for get User Profile Information such as First Name , Last Name , Office and etc. In generally we can not set a default value to InfoPath Person/Group Picker. On the other hand we can not get Current Username in the InfoPath. (Yeh it is true that we can use userName() function. But this will return the Current User Account ID not the name). So we want to use SharePoint user profile services to do this. First we need to  create a user profile connection. Thus First go to Manage connection and click add connection. Then go to receive data option and SOAP Web service and specify the User Profile Service URL . The URL will be something like ( http://sever/sites/site/_vti_bin/UserProfileService.asmx ). This is depends on your site or site collection. if it is a site collection you can omit /sites/site/ part from your URL. then proceed to next , select UserProfileByName and un select the Automatically load. Now you have created the connection....