@@ -12,6 +12,7 @@ The default page transformation configuration (webpartmapping.xml) uses built-in
12
12
### HtmlEncode
13
13
14
14
** Description:** Returns the html encoded value of this string.
15
+
15
16
** Example:** ` {EncodedText} = HtmlEncode({Text}) `
16
17
17
18
#### Input parameters
@@ -27,6 +28,7 @@ Name|Description
27
28
### HtmlEncodeForJson
28
29
29
30
** Description:** Returns the json html encoded value of this string.
31
+
30
32
** Example:** ` {JsonEncodedText} = HtmlEncodeForJson({Text}) `
31
33
32
34
#### Input parameters
@@ -42,6 +44,7 @@ Name|Description
42
44
### ReturnTrue
43
45
44
46
** Description:** Simply returns the string true.
47
+
45
48
** Example:** ` {UsePlaceHolders} = ReturnTrue() `
46
49
47
50
#### Output parameters
@@ -52,6 +55,7 @@ Name|Description
52
55
### ReturnFalse
53
56
54
57
** Description:** Simply returns the string false.
58
+
55
59
** Example:** ` {UsePlaceHolders} = ReturnFalse() `
56
60
57
61
#### Output parameters
@@ -62,6 +66,7 @@ Name|Description
62
66
### ReturnServerRelativePath
63
67
64
68
** Description:** Transforms the incoming path into a server relative path.
69
+
65
70
** Example:** ` {ServerRelativePath} = ReturnServerRelativePath({Path}) `
66
71
67
72
#### Input parameters
@@ -77,6 +82,7 @@ Name|Description
77
82
### ReturnFileName
78
83
79
84
** Description:** Returns the filename of the given path.
85
+
80
86
** Example:** ` {FileName} = ReturnFileName({Path}) `
81
87
82
88
#### Input parameters
@@ -92,6 +98,7 @@ Name|Description
92
98
### Concatenate
93
99
94
100
** Description:** Concatenates 2 strings.
101
+
95
102
** Example:** ` {CompleteString} = Concatenate({String1},{String2}) `
96
103
97
104
#### Input parameters
@@ -108,6 +115,7 @@ Name|Description
108
115
### TextCleanup
109
116
110
117
** Description:** Rewrites wiki page html to be compliant with the html supported by the client side text part.
118
+
111
119
** Example:** ` {CleanedText} = TextCleanup({Text},{UsePlaceHolders}) `
112
120
113
121
#### Input parameters
@@ -124,6 +132,7 @@ Name|Description
124
132
### TextCleanUpSummaryLinks
125
133
126
134
** Description:** Rewrites summarylinks web part html to be compliant with the html supported by the client side text part.
135
+
127
136
** Example:** ` {CleanedText} = TextCleanUpSummaryLinks({Text}) `
128
137
129
138
#### Input parameters
@@ -139,6 +148,7 @@ Name|Description
139
148
### ListAddServerRelativeUrl
140
149
141
150
** Description:** Returns the server relative url of a list.
151
+
142
152
** Example:** ` {ListServerRelativeUrl} = ListAddServerRelativeUrl({ListId}) `
143
153
144
154
#### Input parameters
@@ -154,6 +164,7 @@ Name|Description
154
164
### ListAddWebRelativeUrl
155
165
156
166
** Description:** Returns the web relative url of a list.
167
+
157
168
** Example:** ` {ListWebRelativeUrl} = ListAddWebRelativeUrl({ListId}) `
158
169
159
170
#### Input parameters
@@ -169,6 +180,7 @@ Name|Description
169
180
### ListDetectUsedView
170
181
171
182
** 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
+
172
184
** Example:** ` {ListViewId} = ListDetectUsedView({ListId},{XmlDefinition}) `
173
185
174
186
#### Input parameters
@@ -185,6 +197,7 @@ Name|Description
185
197
### ImageLookup
186
198
187
199
** 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
+
188
201
** Example:** ` ImageLookup({ServerRelativeFileName}) `
189
202
190
203
#### Input parameters
@@ -201,6 +214,7 @@ Name|Description
201
214
### ExtractWebpartProperties
202
215
203
216
** Description:** Extracts the client side web part properties so they can be reused.
217
+
204
218
** Example:** ` {JsonProperties} = ExtractWebpartProperties({ClientSideWebPartData}) `
205
219
206
220
#### Input parameters
@@ -216,6 +230,7 @@ Name|Description
216
230
### DocumentEmbedLookup
217
231
218
232
** 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
+
219
234
** Example:** ` DocumentEmbedLookup({ServerRelativeFileName}) `
220
235
221
236
#### Input parameters
@@ -234,6 +249,7 @@ Name|Description
234
249
### ContentByQueryToHighlightedContentProperties
235
250
236
251
** Description:** Maps content by query web part data into a properties collection for the contentrollup (= Highlighted Content) web part
252
+
237
253
** 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}) `
238
254
239
255
#### Input parameters
@@ -272,6 +288,7 @@ Name|Description
272
288
### TextSelector
273
289
274
290
** Description:** Allows for option to include a spacer for empty text wiki text parts.
291
+
275
292
** Example:** ` TextSelector({CleanedText}) `
276
293
277
294
#### Input parameters
@@ -288,6 +305,7 @@ Spacer|Will be output if the provided wiki text was considered empty
288
305
### ListSelectorListLibrary
289
306
290
307
** Description:** Analyzes a list and returns the list base type.
308
+
291
309
** Example:** ` ListSelectorListLibrary({ListId}) `
292
310
293
311
#### Input parameters
@@ -308,6 +326,7 @@ Undefined|The list base type is undefined
308
326
### ContentEmbedSelectorSourceType
309
327
310
328
** Description:** Analyzes sourcetype and return recommended mapping.
329
+
311
330
** Example:** ` ContentEmbedSelectorSourceType({SourceType}) `
312
331
313
332
#### Input parameters
@@ -324,6 +343,7 @@ ServerFolderOrFile|The embedded content points to a server folder or file
324
343
### ContentEmbedSelectorContentLink
325
344
326
345
** Description:** If ContentLink is set (content editor) then return Link, otherwise return Content.
346
+
327
347
** Example:** ` ContentEmbedSelectorContentLink({ContentLink}) `
328
348
329
349
#### Input parameters
0 commit comments