Skip to content

Commit b1ec06d

Browse files
committed
Fix "heading-with-underline" markdown warnings
1 parent bcf8a45 commit b1ec06d

20 files changed

+1026
-1061
lines changed

docs/solution-guidance/custom-field-type-sharepoint-add-in.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Custom field type in the SharePoint Add-in model
3+
description: The approach you take to provide customized end user experiences is different in the new SharePoint Add-in model than it was with Full Trust Code. In a typical Full Trust Code (FTC) / Farm Solution scenario, custom field types were created with the SharePoint server-side object model code by inheriting from one of the built-in field type classes and creating a field type deployment file (XML).
34
ms.date: 11/03/2017
45
localization_priority: Normal
56
---
6-
Custom field type in the SharePoint Add-in model
7-
================================================
7+
# Custom field type in the SharePoint Add-in model
88

99
## Summary
1010

11-
The approach you take to provide customized end user experiences is different in the new SharePoint Add-in model than it was with Full Trust Code. In a typical Full Trust Code (FTC) / Farm Solution scenario, custom field types were created with the SharePoint server-side object model code by inheriting from one of the built-in field type classes and creating a field type deployment file (XML). These components were deployed via SharePoint solutions.
11+
The approach you take to provide customized end user experiences is different in the new SharePoint Add-in model than it was with Full Trust Code. In a typical Full Trust Code (FTC) / Farm Solution scenario, custom field types were created with the SharePoint server-side object model code by inheriting from one of the built-in field type classes and creating a field type deployment file (XML). These components were deployed via SharePoint solutions.
1212

1313
In a SharePoint Add-ins model scenario, customized end user experiences are implemented via client-side rendering. In this approach, JavaScript files are used to implement customized end user experiences. The remote provisioning pattern deploys the JavaScript files and registers them with SharePoint fields via the JSLink property.
1414

@@ -24,9 +24,11 @@ Here are some examples of custom field type that implements a Google map. These
2424
![Two Google map views showing the Microsoft Campus Location Point, and Location Area.](https://raw.githubusercontent.com/SharePoint/PnP/master/Samples/Branding.JSLink/readme-images/GoogleMaps.png)
2525

2626
**Inline editing showing a larger Google map thumbnail:**
27+
2728
![Two Google maps. One view showing the Microsoft Campus Location Point with a link to Select Location, the other view showing the Microsoft Campus Location Area with a link to Edit Shape.](https://raw.githubusercontent.com/SharePoint/PnP/master/Samples/Branding.JSLink/readme-images/GoogleMaps_Edit.png)
2829

2930
**A dialog enabling inline editing:**
31+
3032
![A Google Map showing the Microsoft Campus Shape. Text on the image reads, Click on the map to place markers and create your shape. Finish by clicking on the first marker. You can drag each of the markers around, or click on them for more options. You can use the Clear Map button above to remove all markers.](https://raw.githubusercontent.com/SharePoint/PnP/master/Samples/Branding.JSLink/readme-images/GoogleMaps_Shape_Edit.png)
3133

3234
## High-level guidelines
@@ -38,89 +40,87 @@ As a rule of a thumb, we would like to provide the following high-level guidelin
3840
- Register the JavaScript files with the Minimal Download Strategy (MDS) engine to ensure the MDS engine is aware of the custom rendering JavaScript files.
3941
- Setting JSLink property to host web requires at least full permission at web level, so this approach is not suitable for add-ins at the SharePoint store
4042

41-
Options to implement client-side rendering with JavaScript files via the JSLink property
42-
----------------------------------------------------------------------------------------
43+
## Options to implement client-side rendering with JavaScript files via the JSLink property
4344

4445
You have a couple of options to implement client-side rendering with JavaScript files via the JSLink property.
4546

46-
- Set the JSLink property on a List View web part that renders a view of a SharePoint list.
47-
- Set the JSLink property for a SharePoint field.
48-
- Set the JSLink property for a SharePoint content type.
49-
47+
- Set the JSLink property on a List View web part that renders a view of a SharePoint list.
48+
- Set the JSLink property for a SharePoint field.
49+
- Set the JSLink property for a SharePoint content type.
50+
51+
## Set the JSLink property on a List View web part that renders a view of a SharePoint list
5052

51-
Set the JSLink property on a List View web part that renders a view of a SharePoint list
52-
-----------------------------------------------------------------------------------------
5353
In this option you set the JSLink property on a WebPartDefinition.
54-
54+
5555
- **This approach does not specifically create a custom field type at the SPField level.**
56-
+ Therefore, *the custom rendering only applies in the List View web part where you set the JSLink property*.
56+
- Therefore, *the custom rendering only applies in the List View web part where you set the JSLink property*.
5757
- This approach allows you to change the rendering for one or more SharePoint fields at once.
5858
- This approach may be done with declarative code, with the SharePoint server-side object model, with the SharePoint client-side object model (CSOM), or via PowerShell.
59-
+ We recommend you use the SharePoint server-side object model, the SharePoint client-side object model, or PowerShell to set the JSLink property via the remote provisioning pattern.
59+
- We recommend you use the SharePoint server-side object model, the SharePoint client-side object model, or PowerShell to set the JSLink property via the remote provisioning pattern.
6060

61-
**When is it a good fit?**
61+
### When is it a good fit?
6262

6363
When you need to define specific views for SharePoint list data and modify the rendering for more than one SharePoint field, this is a good option.
6464

65-
**Getting started**
65+
### Getting started
6666

6767
The following sample sets the JSLink property on a SharePoint List View web part.
6868

6969
- [Branding.ClientSideRendering (O365 PnP Sample)](https://github.com/SharePoint/PnP/tree/master/Samples/Branding.ClientSideRendering)
70-
+ Includes 9 samples that set the JSLink property on a SharePoint List View web part and an explanation of how each sample was implemented.
71-
+ The RegisterJStoWebPart method sets the List View web part's JSLink property.
70+
- Includes 9 samples that set the JSLink property on a SharePoint List View web part and an explanation of how each sample was implemented.
71+
- The RegisterJStoWebPart method sets the List View web part's JSLink property.
7272

73-
Set the JSLink property for a SharePoint field
74-
----------------------------------------------
73+
## Set the JSLink property for a SharePoint field
7574

7675
In this option you set the JSLink property on an SPField.
77-
76+
7877
- **This approach specifically registers the JSLink property at the SPField level.**
79-
+ Therefore, *the custom rendering will apply everywhere the SPField is rendered*.
78+
- Therefore, *the custom rendering will apply everywhere the SPField is rendered*.
8079
- This approach allows you to change the rendering for one SharePoint field.
8180
- This approach may be done with declarative code, with the SharePoint server-side object model, with the SharePoint client-side object model, or via PowerShell.
82-
+ We recommend you use the SharePoint server-side object model, the SharePoint client-side object model, or PowerShell to set the JSLink property via the remote provisioning pattern.
81+
- We recommend you use the SharePoint server-side object model, the SharePoint client-side object model, or PowerShell to set the JSLink property via the remote provisioning pattern.
8382

84-
**When is it a good fit?**
83+
### When is it a good fit?
8584

8685
When you need to define a specific view for a given SharePoint field and ensure the view is always used when the field is rendered, this is a good option.
8786

88-
**Getting started**
87+
### Getting started
8988

9089
The following articles demonstrate how to set the JSLink property on a SPField.
9190

9291
- [Using the JSLink property to change the way your field or views are rendered in SharePoint 2013 (Tobias Zimmergren)](http://zimmergren.net/technical/sp-2013-using-the-spfield-jslink-property-to-change-the-way-your-field-is-rendered-in-sharepoint-2013)
9392
- [Using JSLink with SharePoint 2013 (MSDN Magazine)](https://msdn.microsoft.com/magazine/dn745867.aspx)
9493

95-
Challenges with implementing client-side rendering with JavaScript files via the JSLink property
96-
------------------------------------------------------------------------------------------------
94+
## Challenges with implementing client-side rendering with JavaScript files via the JSLink property
9795

9896
As you develop custom client-side rendering components, keep in mind the following things.
9997

10098
- Not all SharePoint fields may be overridden with the JSLink property.
101-
+ The TaxonomyField is a good example.
99+
- The TaxonomyField is a good example.
102100
- JSLink supports several tokens.
103-
+ _layouts
104-
+ _site
105-
+ _siteCollection
106-
+ _siteCollectionLayouts
107-
+ _siteLayouts
101+
- _layouts
102+
- _site
103+
- _siteCollection
104+
- _siteCollectionLayouts
105+
- _siteLayouts
108106
- You can register the JSLink JavaScript files with the SharePoint Script On Demand (SOD) framework to lazy load the file.
109-
- Use the (d) tag at the end of the JSLink URL to register the file with the SOD.
110-
111-
```
112-
~sitecollection/Style Library/JSLink-Samples/DependentFields.js(d)
113-
```
107+
- Use the (d) tag at the end of the JSLink URL to register the file with the SOD.
108+
109+
```text
110+
~sitecollection/Style Library/JSLink-Samples/DependentFields.js(d)
111+
```
112+
114113
- You can load multiple JavaScript files via the JSLink property.
115-
+ This is especially helpful if you have a library of JavaScript files that implement your client-side rendering.
116-
+ Consider using this approach when targeting mobile devices because it allows you to deliver just the JavaScript you need to implement a given SharePoint field's client-side rendering.
117-
+ Use the | character to separate the JavaScript files you wish to load.
118-
119-
```
120-
~sitecollection/Style Library/JSLink-Samples/MainLibrary.js|~sitecollection/Style Library/JSLink-Samples/SpecificField.js**(d)**
121-
```
114+
- This is especially helpful if you have a library of JavaScript files that implement your client-side rendering.
115+
- Consider using this approach when targeting mobile devices because it allows you to deliver just the JavaScript you need to implement a given SharePoint field's client-side rendering.
116+
- Use the | character to separate the JavaScript files you wish to load.
117+
118+
```text
119+
~sitecollection/Style Library/JSLink-Samples/MainLibrary.js|~sitecollection/Style Library/JSLink-Samples/SpecificField.js**(d)**
120+
```
122121
123122
## Related links
123+
124124
- [SPField.JSLink property (MSDN API Docs)](https://msdn.microsoft.com/library/microsoft.sharepoint.spfield.jslink.aspx)
125125
- [Using the JSLink property to change the way your field or views are rendered in SharePoint 2013 (Tobias Zimmergren)](http://zimmergren.net/technical/sp-2013-using-the-spfield-jslink-property-to-change-the-way-your-field-is-rendered-in-sharepoint-2013)
126126
- [Using JSLink with SharePoint 2013 (MSDN Magazine)](https://msdn.microsoft.com/magazine/dn745867.aspx)

docs/solution-guidance/delegate-controls-sharepoint-add-in.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
22
title: Delegate controls in the SharePoint Add-in model
3+
description: The approach you take to implement delegate controls in your code is different in the new SharePoint Add-in model than it was with Full Trust Code. In a typical Full Trust Code (FTC) / Farm Solution scenario, delegate controls were built as user controls or web controls, registered with features, and deployed via SharePoint Solutions.
34
ms.date: 05/20/2020
45
localization_priority: Normal
56
---
6-
Delegate controls in the SharePoint Add-in model
7-
================================================
7+
# Delegate controls in the SharePoint Add-in model
88

99
## Summary
1010

1111
The approach you take to implement delegate controls in your code is different in the new SharePoint Add-in model than it was with Full Trust Code. In a typical Full Trust Code (FTC) / Farm Solution scenario, delegate controls were built as user controls or web controls, registered with features, and deployed via SharePoint Solutions.
1212

1313
In an SharePoint Add-in model scenario, JavaScript is embedded in SharePoint pages to implement the same functionality as delegate controls.
1414

15-
High Level Guidelines
16-
---------------------
15+
## High Level Guidelines
1716

1817
As a rule of a thumb, we would like to provide the following high level guidelines for creating delegate controls in the new SharePoint Add-in model.
1918

@@ -24,12 +23,14 @@ As a rule of a thumb, we would like to provide the following high level guidelin
2423
See the [User controls and web controls (SharePoint Add-in Model Recipe)](user-controls-and-web-controls-sharepoint-add-in.md) to learn how to embed JavaScript to all SharePoint pages with custom user actions and how to embed JavaScript directly into page layouts and master pages.
2524

2625
## Related links
26+
2727
- [Cross site collection navigation (O365 PnP Video)](https://channel9.msdn.com/blogs/OfficeDevPnP/Cross-site-collection-navigation)
2828
- Guidance articles at [https://aka.ms/OfficeDevPnPGuidance](https://aka.ms/OfficeDevPnPGuidance "Guidance Articles")
2929
- References in MSDN at [https://aka.ms/OfficeDevPnPMSDN](https://aka.ms/OfficeDevPnPMSDN "References in MSDN")
3030
- Videos at [https://aka.ms/OfficeDevPnPVideos](https://aka.ms/OfficeDevPnPVideos "Videos")
3131

3232
## PnP samples
33+
3334
- [OD4B.NavLinksInjection (O365 PnP Sample)](https://github.com/SharePoint/PnP/tree/master/Samples/OD4B.NavLinksInjection)
3435
- Samples and content at [Microsoft 365 Patterns and Practices (PnP)](https://aka.ms/sppnp)
3536

0 commit comments

Comments
 (0)