Skip to content

Commit fdc3be4

Browse files
committed
small fix
1 parent 19e3900 commit fdc3be4

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/transform/modernize-userinterface-site-pages-api.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The default page transformation configuration (webpartmapping.xml) uses built-in
1212
### HtmlEncode
1313

1414
**Description:** Returns the html encoded value of this string.
15+
1516
**Example:** `{EncodedText} = HtmlEncode({Text})`
1617

1718
#### Input parameters
@@ -27,6 +28,7 @@ Name|Description
2728
### HtmlEncodeForJson
2829

2930
**Description:** Returns the json html encoded value of this string.
31+
3032
**Example:** `{JsonEncodedText} = HtmlEncodeForJson({Text})`
3133

3234
#### Input parameters
@@ -42,6 +44,7 @@ Name|Description
4244
### ReturnTrue
4345

4446
**Description:** Simply returns the string true.
47+
4548
**Example:** `{UsePlaceHolders} = ReturnTrue()`
4649

4750
#### Output parameters
@@ -52,6 +55,7 @@ Name|Description
5255
### ReturnFalse
5356

5457
**Description:** Simply returns the string false.
58+
5559
**Example:** `{UsePlaceHolders} = ReturnFalse()`
5660

5761
#### Output parameters
@@ -62,6 +66,7 @@ Name|Description
6266
### ReturnServerRelativePath
6367

6468
**Description:** Transforms the incoming path into a server relative path.
69+
6570
**Example:** `{ServerRelativePath} = ReturnServerRelativePath({Path})`
6671

6772
#### Input parameters
@@ -77,6 +82,7 @@ Name|Description
7782
### ReturnFileName
7883

7984
**Description:** Returns the filename of the given path.
85+
8086
**Example:** `{FileName} = ReturnFileName({Path})`
8187

8288
#### Input parameters
@@ -92,6 +98,7 @@ Name|Description
9298
### Concatenate
9399

94100
**Description:** Concatenates 2 strings.
101+
95102
**Example:** `{CompleteString} = Concatenate({String1},{String2})`
96103

97104
#### Input parameters
@@ -108,6 +115,7 @@ Name|Description
108115
### TextCleanup
109116

110117
**Description:** Rewrites wiki page html to be compliant with the html supported by the client side text part.
118+
111119
**Example:** `{CleanedText} = TextCleanup({Text},{UsePlaceHolders})`
112120

113121
#### Input parameters
@@ -124,6 +132,7 @@ Name|Description
124132
### TextCleanUpSummaryLinks
125133

126134
**Description:** Rewrites summarylinks web part html to be compliant with the html supported by the client side text part.
135+
127136
**Example:** `{CleanedText} = TextCleanUpSummaryLinks({Text})`
128137

129138
#### Input parameters
@@ -139,6 +148,7 @@ Name|Description
139148
### ListAddServerRelativeUrl
140149

141150
**Description:** Returns the server relative url of a list.
151+
142152
**Example:** `{ListServerRelativeUrl} = ListAddServerRelativeUrl({ListId})`
143153

144154
#### Input parameters
@@ -154,6 +164,7 @@ Name|Description
154164
### ListAddWebRelativeUrl
155165

156166
**Description:** Returns the web relative url of a list.
167+
157168
**Example:** `{ListWebRelativeUrl} = ListAddWebRelativeUrl({ListId})`
158169

159170
#### Input parameters
@@ -169,6 +180,7 @@ Name|Description
169180
### ListDetectUsedView
170181

171182
**Description:** Detects the list view id that was used by the webpart by mapping the web part xmldefinition to the list views. If no view found the list default view id is returned.
183+
172184
**Example:** `{ListViewId} = ListDetectUsedView({ListId},{XmlDefinition})`
173185

174186
#### Input parameters
@@ -185,6 +197,7 @@ Name|Description
185197
### ImageLookup
186198

187199
**Description:** Does lookup a file based on the given server relative path and return needed properties of the file. Returns null if file was not found.
200+
188201
**Example:** `ImageLookup({ServerRelativeFileName})`
189202

190203
#### Input parameters
@@ -201,6 +214,7 @@ Name|Description
201214
### ExtractWebpartProperties
202215

203216
**Description:** Extracts the client side web part properties so they can be reused.
217+
204218
**Example:** `{JsonProperties} = ExtractWebpartProperties({ClientSideWebPartData})`
205219

206220
#### Input parameters
@@ -216,6 +230,7 @@ Name|Description
216230
### DocumentEmbedLookup
217231

218232
**Description:** Does lookup a file based on the given server relative path and return needed properties of the file. Returns null if file was not found.
233+
219234
**Example:** `DocumentEmbedLookup({ServerRelativeFileName})`
220235

221236
#### Input parameters
@@ -234,6 +249,7 @@ Name|Description
234249
### ContentByQueryToHighlightedContentProperties
235250

236251
**Description:** Maps content by query web part data into a properties collection for the contentrollup (= Highlighted Content) web part
252+
237253
**Example:** `{JsonProperties} = ContentByQueryToHighlightedContentProperties({WebUrl},{ListGuid},{ListName},{ServerTemplate},{ContentTypeBeginsWithId},{FilterField1},{Filter1ChainingOperator},{FilterDisplayValue1},{FilterOperator1},{FilterField2},{Filter2ChainingOperator},{FilterDisplayValue2},{FilterOperator2},{FilterField3},{FilterDisplayValue3},{FilterOperator3},{SortBy},{SortByDirection},{GroupBy},{GroupByDirection},{ItemLimit},{DisplayColumns},{DataMappings})`
238254

239255
#### Input parameters
@@ -272,6 +288,7 @@ Name|Description
272288
### TextSelector
273289

274290
**Description:** Allows for option to include a spacer for empty text wiki text parts.
291+
275292
**Example:** `TextSelector({CleanedText})`
276293

277294
#### Input parameters
@@ -288,6 +305,7 @@ Spacer|Will be output if the provided wiki text was considered empty
288305
### ListSelectorListLibrary
289306

290307
**Description:** Analyzes a list and returns the list base type.
308+
291309
**Example:** `ListSelectorListLibrary({ListId})`
292310

293311
#### Input parameters
@@ -308,6 +326,7 @@ Undefined|The list base type is undefined
308326
### ContentEmbedSelectorSourceType
309327

310328
**Description:** Analyzes sourcetype and return recommended mapping.
329+
311330
**Example:** `ContentEmbedSelectorSourceType({SourceType})`
312331

313332
#### Input parameters
@@ -324,6 +343,7 @@ ServerFolderOrFile|The embedded content points to a server folder or file
324343
### ContentEmbedSelectorContentLink
325344

326345
**Description:** If ContentLink is set (content editor) then return Link, otherwise return Content.
346+
327347
**Example:** `ContentEmbedSelectorContentLink({ContentLink})`
328348

329349
#### Input parameters

0 commit comments

Comments
 (0)