forked from jcroav/SPHelpers
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathHelpers.cs
447 lines (387 loc) · 18.6 KB
/
Helpers.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
public static class Helpers
{
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="group"></param>
/// <param name="description"></param>
/// <param name="name"></param>
/// <param name="displayName"></param>
/// <param name="maxLength"></param>
public static void CreateTextColumn(this SPWeb web, string group, string description, string name, string displayName, int maxLength = 255)
{
try
{
if (!web.Fields.ContainsField(name))
{
string fieldName = web.Fields.Add(name, SPFieldType.Text, false);
SPFieldText field = (SPFieldText)web.Fields.GetField(name);
field.Group = group;
field.MaxLength = maxLength;
field.StaticName = name;
field.Title = displayName;
field.NoCrawl = false;
field.Description = description;
field.Update();
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateTextColumn. MESSAGE: {0}. EXCEPTION TRACE: {1} ",ex.Message,ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="group"></param>
/// <param name="description"></param>
/// <param name="name"></param>
/// <param name="displayName"></param>
/// <param name="decimals"></param>
public static void CreateNumberColumn(this SPWeb web, string group, string description, string name, string displayName, SPNumberFormatTypes decimals = SPNumberFormatTypes.Automatic)
{
try
{
if (!web.Fields.ContainsField(name))
{
string fieldName = web.Fields.Add(name, SPFieldType.Number, false);
SPFieldNumber field = (SPFieldNumber)web.Fields.GetField(name);
field.Group = group;
field.DisplayFormat = decimals;
field.StaticName = name;
field.Title = displayName;
field.NoCrawl = false;
field.Description = description;
field.Update();
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateNumberColumn. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="group"></param>
/// <param name="description"></param>
/// <param name="name"></param>
/// <param name="displayName"></param>
/// <param name="options"></param>
/// <param name="defaultOption"></param>
public static void CreateChoiceColumn(this SPWeb web, string group, string description, string name, string displayName, string [] options, string defaultOption = "")
{
try
{
if (!web.Fields.ContainsField(name))
{
string fieldName = web.Fields.Add(name, SPFieldType.Choice, false);
SPFieldChoice field = (SPFieldChoice)web.Fields.GetField(name);
field.Group = group;
field.Choices.AddRange(options);
field.DefaultValue = defaultOption;
field.FillInChoice = true;
field.StaticName = name;
field.Title = displayName;
field.NoCrawl = false;
field.Description = description;
field.Update();
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateChoiceColumn. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
public static void CreateNoteColumn(this SPWeb web, string group, string description, string name, string displayName, int numberOfLines, bool richText = true)
{
try
{
if (!web.Fields.ContainsField(name))
{
string fieldName = web.Fields.Add(name, SPFieldType.Note, false);
SPFieldMultiLineText field = (SPFieldMultiLineText)web.Fields.GetField(name);
field.Group = group;
field.RichText = richText;
field.NumberOfLines = numberOfLines;
field.StaticName = name;
field.Title = displayName;
field.NoCrawl = false;
field.Description = description;
field.Update();
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateNoteColumn. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
public static void CreateUserColumn(this SPWeb web, string group, string description, string name, string displayName)
{
try
{
if (!web.Fields.ContainsField(name))
{
string fieldName = web.Fields.Add(name, SPFieldType.User, false);
SPFieldUser field = (SPFieldUser)web.Fields.GetField(name);
field.Group = group;
field.StaticName = name;
field.Title = displayName;
field.NoCrawl = false;
field.Description = description;
field.Update();
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateUserColumn. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="group"></param>
/// <param name="dscription"></param>
/// <param name="name"></param>
/// <param name="displayName"></param>
public static void CreateBooleanColumn(this SPWeb web, string group, string description, string name, string displayName)
{
try
{
if (!web.Fields.ContainsField(name))
{
string fieldName = web.Fields.Add(name, SPFieldType.Boolean, false);
SPFieldBoolean field = (SPFieldBoolean)web.Fields.GetField(name);
field.Group = group;
field.StaticName = name;
field.Title = displayName;
field.NoCrawl = false;
field.Description = description;
field.Update();
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateBooleanColumn. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
public static void CreateDateTimeColumn(this SPWeb web, string group, string description, string name, string displayName, SPDateTimeFieldFormatType format = SPDateTimeFieldFormatType.DateOnly)
{
try
{
if (!web.Fields.ContainsField(name))
{
string fieldName = web.Fields.Add(name, SPFieldType.DateTime, false);
SPFieldDateTime field = (SPFieldDateTime)web.Fields.GetField(name);
field.Group = group;
field.StaticName = name;
field.DisplayFormat = format;
field.Title = displayName;
field.NoCrawl = false;
field.Description = description;
field.Update();
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateDateTimeColumn. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="parentId"></param>
/// <param name="group"></param>
/// <param name="name"></param>
public static void CreateContentType(this SPWeb web, string parentId, string group, string name, string description)
{
try
{
if (web.AvailableContentTypes[name] == null)
{
SPContentType itemCType = web.AvailableContentTypes[new SPContentTypeId(parentId)];
if (itemCType != null)
{
SPContentType contentType =
new SPContentType(itemCType, web.ContentTypes, name) { Group = @group };
web.ContentTypes.Add(contentType);
contentType.Update();
}
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateContentType. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="contentName"></param>
/// <param name="column"></param>
/// <param name="required"></param>
/// <param name="readonlyField"></param>
public static void AddColumntToContentType(this SPWeb web, string contentName, string column, bool required = false, bool readonlyField = false)
{
try
{
SPContentType contentType = web.ContentTypes[contentName];
if (contentType != null)
{
if (!contentType.Fields.ContainsField(column))
{
SPField field = web.Fields.GetField(column);
SPFieldLink fieldLink = new SPFieldLink(field);
fieldLink.Required = required;
fieldLink.ReadOnly = readonlyField;
contentType.FieldLinks.Add(fieldLink);
contentType.Update(true);
}
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:AddColumntToContentType. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="name"></param>
/// <param name="description"></param>
/// <param name="template"></param>
public static void CreateList(this SPWeb web, string name, string description, SPListTemplateType template = SPListTemplateType.GenericList, bool allowModeration = false, bool allowVersioning = false)
{
try
{
if (web.Lists.TryGetList(name) == null)
web.Lists.Add(name, description, template);
string listUrl = String.Format("Lists/{0}", name);
SPList list = web.GetList(listUrl);
list.EnableModeration = allowModeration;
list.EnableVersioning = allowVersioning;
list.Update();
web.Update();
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:CreateList. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="listName"></param>
/// <param name="contentTypeName"></param>
public static void AddContentTypeToList(this SPWeb web, string listName, string contentTypeName)
{
try
{
SPContentType contentTypes = web.AvailableContentTypes[contentTypeName];
if (contentTypes != null)
{
string listUrl = String.Format("Lists/{0}", listName);
SPList list = web.GetList(listUrl);
list.ContentTypesEnabled = true;
list.ContentTypes.Add(contentTypes);
list.EnableFolderCreation = false;
list.Update();
}
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:AddContentTypeToList. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="p"></param>
public static void DeleteList(this SPWeb web, string listName)
{
try
{
string listUrl = String.Format("Lists/{0}", listName);
SPList list = web.GetList(listUrl);
System.Guid listGuid = list.ID;
web.Lists.Delete(listGuid);
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:DeleteList. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="contentTypeName"></param>
public static void RemoveContentType(this SPWeb web, string contentTypeName)
{
try
{
web.AllowUnsafeUpdates = true;
SPContentTypeCollection contentTypes = web.ContentTypes;
contentTypes.Delete(contentTypes[contentTypeName].Id);
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:RemoveContentType. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
finally
{
web.AllowUnsafeUpdates = true;
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="siteColumnName"></param>
public static void RemoveSiteColumn(this SPWeb web, string siteColumnName)
{
try
{
if (web.Fields.ContainsField(siteColumnName))
web.Fields.Delete(siteColumnName);
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:RemoveSiteColumn. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
/// <summary>
///
/// </summary>
/// <param name="web"></param>
/// <param name="page"></param>
/// <param name="webPartZone"></param>
/// <param name="order"></param>
/// <param name="webpart"></param>
public static void AddWebPartToPage(this SPWeb web, string page, string webPartZone, int order, System.Web.UI.WebControls.WebParts.WebPart webpart)
{
try
{
SPFile file = web.GetFile(page);
if (!file.Exists)
{
throw new SPException(string.Format("File '{0}' does not exist", file.ServerRelativeUrl));
}
SPLimitedWebPartManager partManager = file.GetLimitedWebPartManager(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared);
partManager.AddWebPart(webpart, webPartZone, order);
}
catch (Exception ex)
{
SPDiagnosticsService.Local.WriteTrace(0, new SPDiagnosticsCategory("CORE:HELPERS", TraceSeverity.Unexpected, EventSeverity.Error), TraceSeverity.Unexpected, String.Format("Exception happened in Helpers:AddWebPartToPage. MESSAGE: {0}. EXCEPTION TRACE: {1} ", ex.Message, ex.StackTrace), ex.StackTrace);
}
}
}