Site property bag
Microsoft's edit ·
Microsoft's commit message in SharePoint/sp-dev-docs · commit a55d4a4 · +116 −0 lines · also on GitHub
The file is new at this commit, or was moved here from another path: every line shows as added.
1
+---
2
+manager: soliver
3
+ms.date: 3/9/2015
4
+ms.audience: Developer
5
+ms.topic: reference
6
+ms.prod: office-online-server
7
+localization_priority: Normal
8
+api_name:
9
+- Property Bag Schema
10
+ms.assetid: f249df32-1c9a-4d60-96e7-a97f0dd8f5f4
11
+---
12
+
13
+# PropertyBag Element (Property Bag)
14
+
15
+**Applies to**: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013
16
+
17
+Specifies the properties in the property bag for the list item, file, folder, or website.
18
+
19
+## Definition
20
+
21
+```XML
22
+<PropertyBag
23
+ HyperlinkBaseUrl = "Text"
24
+ ItemIndex = "Text"
25
+ ParentType = "PropertyBagParentTypeDefinition"
26
+ RootWebOnly = "Text"
27
+ Url = "Text">
28
+
29
+ <Property ... />
30
+</ PropertyBag >
31
+```
32
+
33
+## Elements and attributes
34
+
35
+The following sections describe attributes, child elements, and parent elements.
36
+
37
+### Attributes
38
+
39
+<table>
40
+<colgroup>
41
+<col width="20%" />
42
+<col width="80%" />
43
+</colgroup>
44
+<thead>
45
+<tr class="header">
46
+<th align="left"><p>Attribute</p></th>
47
+<th align="left"><p>Description</p></th>
48
+</tr>
49
+</thead>
50
+<tbody>
51
+<tr class="odd">
52
+<td align="left"><p>**HyperlinkBaseUrl**</p></td>
53
+<td align="left"><p>Optional **Text**. Specifies an absolute URL to use as the base URL for hyperlinks.</p></td>
54
+</tr>
55
+<tr class="even">
56
+<td align="left"><p>**ItemIndex**</p></td>
57
+<td align="left"><p>Optional **Text**. Specifies the ID of the list item. This attribute is used only when **ParentType** is "ListItem".</p></td>
58
+</tr>
59
+<tr class="odd">
60
+<td align="left"><p>**ParentType**</p></td>
61
+<td align="left"><p>Required **PropertyBagParentTypeDefinition** enumeration. Must be one of **File**, **Folder**, **ListItem**, or **Web**. Specifies the kind of object to which the property bag belongs.</p></td>
62
+</tr>
63
+<tr class="even">
64
+<td align="left"><p>**RootWebOnly**</p></td>
65
+<td align="left"><p>Optional **TRUE/FALSE**. Indicates whether the parent object must be the site collection's top-level site when the **ParentType** attribute is "Web". This attribute is not used with any other **ParentType** value.</p></td>
66
+</tr>
67
+<tr class="odd">
68
+<td align="left"><p>**Url**</p></td>
69
+<td align="left"><p>Optional **Text**. The site-relative URL of the parent object to which the property bag belongs, except when **ParentType** is "ListItem". In that case, this attribute specifies the site-relative URL of the list, not the list item.</p></td>
70
+</tr>
71
+</tbody>
72
+</table>
73
+
74
+### Child elements
75
+
76
+<table>
77
+<colgroup>
78
+<col width="100%" />
79
+</colgroup>
80
+<tbody>
81
+<tr class="odd">
82
+<td align="left"><p><a href="property-element-property-bag.md">Property</a></p></td>
83
+</tr>
84
+</tbody>
85
+</table>
86
+
87
+### Parent elements
88
+
89
+<table>
90
+<colgroup>
91
+<col width="100%" />
92
+</colgroup>
93
+<tbody>
94
+<tr class="odd">
95
+<td align="left"><p><a href="elements-element-property-bag.md">Elements</a></p></td>
96
+</tr>
97
+</tbody>
98
+</table>
99
+
100
+### Occurrences
101
+
102
+<table>
103
+<colgroup>
104
+<col width="100%" />
105
+</colgroup>
106
+<tbody>
107
+<tr class="odd">
108
+<td align="left"><p>Minimum: 0</p>
109
+<p>Maximum: Unbounded</p></td>
110
+</tr>
111
+</tbody>
112
+</table>
113
+
114
+## Example
115
+
116
+For an example of how this element is used, see [Property Bag Schema](property-bag-schema.md).
Microsoft's Markdown source from SharePoint/sp-dev-docs, © Microsoft Corporation, under CC BY 4.0. Changed lines with up to 3 unchanged lines around each; ChangeIntel kept this copy 12 Oct 19:35 UTC. The commit date is when the source changed, which can be hours or days before Learn published it.