Edit

How-tos for SharePoint Development

  • Article

SharePoint

Find how-to articles and related code examples that show how to perform basic development tasks in SharePoint, including how to set up your development environment and start building sites, SharePoint Framework and SharePoint Add-ins.

Getting started how-tos for SharePoint Framework

Title Summary
Set up your SharePoint Framework development environment Learn how to set up a development environment for SharePoint Framework development.
Building your first SharePoint client-side web part Learn how to get started with developing SharePoint Framework client-side web parts.
Build your first SharePoint Framework Extension Learn how to get started with developing SharePoint Framework Extensions.

Getting started how-tos for SharePoint Add-ins

Title Summary
Set up an on-premises development environment for SharePoint Add-ins Learn how to set up a development environment that is specifically suited to developing SharePoint Add-ins with an on-premises installation of SharePoint.
Get started creating provider-hosted SharePoint Add-ins Learn how to create a basic provider-hosted SharePoint Add-in with the Office Developer Tools for Visual Studio 2012, how to interact with SharePoint sites by using the SharePoint CSOM, and how to implement OAuth in an SharePoint Add-in.
Get started creating SharePoint-hosted SharePoint Add-ins Learn how to create a basic SharePoint-hosted SharePoint Add-in with the Office Developer Tools for Visual Studio 2012.

Development how-tos for SharePoint Add-ins

Title Summary
Complete basic operations using SharePoint client library code Learn how to write code to perform basic operations with the SharePoint .NET Framework client object model (CSOM).
Complete basic operations using JavaScript library code in SharePoint Learn how to write code to perform basic operations using the JavaScript client object model in SharePoint.
Complete basic operations using SharePoint REST endpoints Learn how to perform basic create, read, update, and delete (CRUD) operations with the SharePoint REST interface.
Use a SharePoint website's style sheet in SharePoint Add-ins Learn how to use a SharePoint website's style sheet in an SharePoint Add-in.
Use the client chrome control in SharePoint Add-ins Learn how to use the chrome control in apps in SharePoint.
Create add-in parts to install with your SharePoint Add-in Learn how to create an app part in SharePoint that is available in the Web Part Gallery of the host web when you deploy your SharePoint Add-in.
Create custom actions to deploy with SharePoint Add-ins Learn how to create a custom action in SharePoint that deploys to the host web when you deploy an SharePoint Add-in.
Customize a list view in SharePoint Add-ins using client-side rendering Learn how to customize a list view in a SharePoint-hosted app by using the client-side rendering technology in SharePoint.
Use the client-side People Picker control in SharePoint-hosted SharePoint Add-ins Learn how to use the client-side People Picker control in SharePoint Add-ins.
Create a custom proxy page for the cross-domain library in SharePoint Learn how to create a custom proxy page to access data in a remote service from a SharePoint webpage by using the cross domain library in SharePoint.
Query a remote service using the web proxy in SharePoint Learn how to access data in a remote domain from a page that is hosted in SharePoint by using the web proxy.
Access SharePoint data from add-ins using the cross-domain library Learn how to access data in a SharePoint website from a remote app by using the cross domain library in SharePoint.
Create a remote event receiver in SharePoint Add-ins Learn the basics about how to handle, add, and remove events in an SharePoint Add-in by using the Office Developer Tools for Visual Studio 2012.
Create an add-in event receiver in SharePoint Add-ins Learn the basics about how to create a receiver and add or remove handlers for events that occur to an SharePoint Add-in by using the Office Developer Tools for Visual Studio 2012.
Create a provider-hosted add-in that includes a custom SharePoint list and content type Create an SharePoint Add-in that combines a cloud-hosted web application with custom SharePoint-hosted list templates, list instances, and custom content types by using the Office Developer Tools for Visual Studio 2012. Learn how to interact with SharePoint app webs by using the REST/OData web service, and how to implement OAuth in an SharePoint Add-in.
Get user identity and properties in SharePoint Learn the different ways to retrieve user identity and user information in SharePoint.
Localize SharePoint Add-ins Localize an SharePoint Add-in by using resource files, JavaScript "resource" files, and other techniques.
Create high-trust SharePoint Add-ins Learn how to create a high-trust app for SharePoint. A high-trust app is a provider-hosted app for use on-premises that uses the server-to-server protocol.
Package and publish high-trust SharePoint Add-ins Learn how to package and publish a high-trust SharePoint Add-in for on-premises use.

Publishing how-tos for Office and SharePoint Add-ins

Title Summary
Publish SharePoint Add-ins by using Visual Studio Learn how to package your SharePoint Add-in by using Visual Studio 2012.
Create or edit a Seller Dashboard seller account and add payout information The Microsoft Seller Dashboard is the central location for app developers to submit Office and SharePoint Add-ins. Learn how to create a seller account, including a marketing profile, so that you can submit apps for inclusion in the Office Store.
Create or update client IDs and secrets in the Seller Dashboard Learn how to create Client IDs and secrets, and associate them with your apps in the Seller Dashboard to enable Open Authorization (OAuth) authorization services in your Office and SharePoint Add-ins.
Use the Seller Dashboard to submit Office and SharePoint Add-ins and Office 365 apps to the Office Store The Microsoft Seller Dashboard enables software developers to submit apps for SharePoint and Office to the Office Store. Learn how to submit your apps for approval and inclusion in the Office Store.
Create effective Office Store apps and add-ins Get guidance on how to create an effective Office Store listing: name your app appropriately, write effective, engaging app descriptions for your app, and include consistent, properly formatted logos with your app submission to the Seller Dashboard.

Licensing how-tos for Office and SharePoint Add-ins

Title Summary
Add license checks to your apps for Office Learn how to add code to your Office Add-in that checks the validity of a user's app license, and takes action based on the app license properties. Load test app license tokens to test your license checking code.
Add license checks to Office and SharePoint Add-ins Learn how to add code to your SharePoint Add-in that checks the validity of a user's app license, and takes action based on the app license properties. Load test app license tokens to test your license checking code.

Setting up your dev environment how-tos for developing sites and solutions in SharePoint

Title Summary
Detect the installed SKU of SharePoint If the behavior of your solutions depends on the locally installed SKU of SharePoint or Project Server 2013, use the code sample in this article to find the SKU information you need.
Set up an environment for developing mobile apps for SharePoint Learn about the system requirements and configuring a development environment for SharePoint mobility projects.

Customization how-tos for SharePoint

Title Summary
Customize a field type using client-side rendering Learn how to customize a field type by using the client-side rendering technology in SharePoint.
Customize list item queries and filter data for Windows Phone apps Customize the data queries on which the views in a Windows Phone app are based.
Customize the user interface of a SharePoint list app for Windows Phone Customize the Windows Phone user interface generated by the Windows Phone SharePoint List Application template.

Building mobile apps how-tos for SharePoint

Title Summary
Set up an environment for developing mobile apps for SharePoint Learn about the system requirements and configuring a development environment for SharePoint mobility projects.
Create a Windows Phone SharePoint list app Create a Windows Phone app in Visual Studio based on the Windows Phone SharePoint List Application template.
Store and retrieve SharePoint list items on a Windows Phone Learn about the Windows Phone application life cycle and storing network data locally.
Implement business logic and data validation in a Windows Phone app for SharePoint Implement data validation in a Windows Phone app created by using the Windows Phone SharePoint List Application template.
Support and convert SharePoint field types for Windows Phone apps Implement data-conversion logic to support SharePoint field types in Windows Phone apps.
Customize list item queries and filter data for Windows Phone apps Customize the data queries on which the views in a Windows Phone app are based.
Customize the user interface of a SharePoint list app for Windows Phone Customize the Windows Phone user interface generated by the Windows Phone SharePoint List Application template.
Use multiple SharePoint lists in a Windows Phone app Create Windows Phone apps that use data from multiple SharePoint lists.
Configure and use push notifications in SharePoint apps for Windows Phone Create a solution in SharePoint Server for sending push notifications and develop a Windows Phone app for receiving the notifications.
Create a mobile app in SharePoint that contains data from an external data source Learn how to create a simple mobile app in SharePoint that contains data from external data source by using Business Connectivity Services (BCS) and connecting to an external list.
Integrate maps with Windows Phone apps and SharePoint lists Learn how to integrate location information and maps in SharePoint lists and location-based web and mobile SharePoint Add-ins, by using the new Geolocation field, and by creating your own geolocation-based field types.
Build search-driven mobile apps with the Navigation and Event Logging REST interfaces SharePoint introduces the Navigation and Event Logging REST interfaces, enabling you to create a search-driven mobile app for mobile devices such as phones and tablets that run on operating systems other than Windows???for example, Android and iOS.
Export the Name field in a Document Library list to a mobile app Export the Name field of a Document Library list to a mobile app by using the Visual Studio SharePoint List wizard. The Name field does not appear automatically when a user creates a mobile app for a document library in SharePoint.

Building sites using Design Manager how-tos for SharePoint

Title Summary
Use code to pin terms to navigation term sets in SharePoint Learn how to use code to pin terms to navigation term sets.
Create device channels in SharePoint Learn how to create a device channel, change a device channel, delete a device channel, and reorder device channels in SharePoint.
Map a network drive to the SharePoint Master Page Gallery Learn how to map a network drive to the Master Page Gallery so that you can use Design Manager to upload design files in SharePoint.
Convert an HTML file into a master page in SharePoint With Design Manager, you can convert an .html file into a SharePoint master page, a .master file. After the conversion, the HTML file and master page are associated, so that when you edit and save the HTML file, the changes are synced to the associated master page.
Apply a master page to a site in SharePoint Learn how to map a master page to a SharePoint site.
Create a page layout in SharePoint When you use Design Manager to create a page layout, two files are created: an .aspx file that SharePoint uses, and an HTML version of that page layout that you can edit in your HTML editor. The HTML file and page layout are associated, so that whenever you edit and save the HTML file, your changes are synced to the associated page layout.
Resolve errors and warnings when previewing a page in SharePoint After you convert an HTML file into a SharePoint master page, or after you create a page layout, you can preview that page in the browser. But before you can preview a master page or page layout, you may have to resolve any issues that prevent the server-side preview from rendering your page.
Change the preview page in SharePoint Design Manager Learn how to set, create, and change the preview page in Design Manager in SharePoint.
Add a Device Channel Panel snippet in SharePoint A Device Channel Panel is a snippet that you can add to a master page or page layout to control what content is rendered for each channel that you create. The primary purpose of a Device Channel Panel is to selectively display different page fields on different channels from a single page layout.
Add an Edit Mode Panel snippet in SharePoint An Edit Mode Panel is a snippet that you can use to display instructions or other content to content authors, who see the contents of that panel only when they edit a page. Conversely, this snippet can also be configured to display its contents only in regular (view) mode instead of in edit mode.
Add a web part zone snippet in SharePoint A web part zone is a snippet that you can add to a page layout so that content authors can add, edit, or delete web parts in that zone.
Add a Security Trim snippet in SharePoint You can use a Security Trim snippet to display content only to specific users, based on a specific permission that those users must have and whether the users are authenticated or anonymous.
SharePoint Design Manager image renditions Learn how to create, edit, or delete image renditions. An image rendition defines the dimensions that are used to display images in SharePoint publishing sites.
Add an image rendition to a page in SharePoint Learn how to use image renditions in a SharePoint publishing site.
Crop an image rendition in SharePoint Learn how to specify the portion of the image to use in an image rendition.

Workflow how-tos for SharePoint

Title Summary
Build and deploy workflow custom actions Learn how to model business processes whose requirements are not met by the existing library of workflow actions in SharePoint Designer by creating custom workflow actions in SharePoint.

Social and collaboration how-tos for SharePoint

Title Summary
Read and write to the social feed by using the .NET client object model in SharePoint Create a console application that reads and writes to the social feed by using the SharePoint .NET client object model.
Read and write to the social feed by using the REST service in SharePoint Create a SharePoint-hosted app that uses the REST service to publish a post and get the personal feed for the current user.
Create and delete posts and retrieve the social feed by using the .NET client object model in SharePoint Learn how to create and delete microblog posts and retrieve social feeds by using the SharePoint .NET client object model.
Create and delete posts and retrieve the social feed by using the JavaScript object model in SharePoint Learn how to create and delete microblog posts and retrieve social feeds by using the SharePoint JavaScript object model.
Include mentions, tags, and links to sites and documents in posts in SharePoint Learn how to add SocialDataItem objects to microblog posts, which render as mentions, tags, or links in SharePoint social feeds.
Embed images, videos, and documents in posts in SharePoint Learn how to add SocialAttachment objects to microblog posts, which render as embedded pictures, videos, and documents in SharePoint social feeds.
Follow people by using the .NET client object model in SharePoint Learn how to work with Following People features by using the SharePoint .NET client object model.
Follow people by using the JavaScript object model in SharePoint Learn how to work with Following People features by using the SharePoint JavaScript object model.
Follow documents and sites by using the .NET client object model in SharePoint Learn how to work with Following Content features by using the SharePoint .NET client object model.
Follow documents, sites, and tags by using the REST service in SharePoint Learn how to work with Following Content features by using the SharePoint REST service.
Retrieve user profile properties by using the .NET client object model in SharePoint Learn how to retrieve user profile properties programmatically by using the SharePoint .NET client object model.
Retrieve user profile properties by using the JavaScript object model in SharePoint Learn how to retrieve user properties and user profile properties programmatically by using the SharePoint JavaScript object model.
Work with user profiles and organization profiles by using the server object model in SharePoint Learn how to create, retrieve, and change SharePoint user profiles and user profile properties programmatically by using the SharePoint server object model.

Integrating location and map functionality how-tos for SharePoint

Title Summary
Add a Geolocation column to a list programmatically in SharePoint Learn how to programmatically add a Geolocation column to a list in SharePoint. Integrate location information and maps in SharePoint lists and location-based websites by using the new Geolocation field creating your own geolocation-based field type.
Set the Bing Maps key at the web and farm level in SharePoint Learn how to set the Bing Maps key programmatically at the web and farm level by using the SharePoint client object model and Windows PowerShell, to enable the Bing Maps functionality in SharePoint lists and location-based web and mobile apps.
Extend the Geolocation field type using client-side rendering Learn how to customize the SharePoint Geolocation field type programmatically using client-side rendering.

Search how-tos for SharePoint

Title Summary
Crawl associated external content types in SharePoint Learn how to use the search specific properties in the Business Data Connectivity (BDC) service metadata model for crawling associations, and the different user experiences that you can enable.
Crawl binary large objects (BLOBs) in SharePoint Learn how to modify the BDC model file for a database BCS indexing connector to enable the Search in SharePoint crawler to crawl binary large object (BLOB) data stored in a SQL Server database.
Configure item-level security in SharePoint Learn how to configure item level security when crawling external data with BCS indexing connectors in SharePoint.
Use the Content Enrichment web service callout for SharePoint Server Learn how to implement the Content Enrichment web service in SharePoint to modify the managed properties of crawled items before they are indexed.
Use a custom security trimmer for SharePoint Server search results This how-to guides you through the steps to implement???create, deploy, and register???a custom security trimmer for Search in SharePoint by using Visual Studio 2010.

BCS how-tos for SharePoint

Title Summary
Create external content types for SQL Server in SharePoint Learn how to create an external content type for SQL Server in SharePoint.
Create an external content type from an OData source in SharePoint Learn how to use Visual Studio 2012 to discover a published OData source and create a reusable external content type for use in BCS in SharePoint.
Create an OData data service for use as a BCS external system Learn how to create an Internet-addressable WCF service that uses OData to send notifications to SharePoint when the underlying data changes. These notifications are used to trigger events that are attached to external lists.
Create an external list using an OData data source in SharePoint Learn how to create an external list programmatically and bind it to an OData-based external content type in SharePoint.
Create an add-in-scoped external content type in SharePoint Learn how to create external content types that can be installed, secured, and used in an SharePoint Add-in.
Access external data with REST in SharePoint Learn how to access external data from SharePoint by using Representational State Transfer (REST) URLs for BCS.
Use the client code library to access external data in SharePoint Learn how to use the SharePoint client object model to work with BCS objects in SharePoint using browser-based scripting.

Office and SharePoint application services how-tos for SharePoint

Title Summary
Create report renderers for PerformancePoint Services in SharePoint Learn how to create the renderer component in a custom report extension for PerformancePoint Services.
Create report editors for PerformancePoint Services in SharePoint Learn how to create the editor component of a custom report extension for PerformancePoint Services.
Create filter data providers for PerformancePoint Services in SharePoint Learn how to create the data provider component in a custom filter extension for PerformancePoint Services.
Create filter editors for PerformancePoint Services in SharePoint Learn how to create the editor component of a custom filter extension for PerformancePoint Services.
Create tabular data source providers for PerformancePoint Services in SharePoint Learn how to create the data source provider component in a custom tabular data source extension for PerformancePoint Services.
Create tabular data source editors for PerformancePoint Services in SharePoint Learn how to create the editor component of a custom tabular data source extension for PerformancePoint Services.
Create scorecard transforms for PerformancePoint Services in SharePoint Learn how to create custom scorecard transforms for PerformancePoint Services in SharePoint.

Authentication, authorization, and security how-tos in SharePoint

Title Summary
Create a claims provider in SharePoint Learn how to create and implement a SharePoint claims provider that fulfills the requirements for claims augmentation and claims picking.
Deploy a claims provider in SharePoint Learn how to deploy a SharePoint claims provider by using the features infrastructure and creating a class that inherits from SPClaimProviderFeatureReceiver.

See also