Создание типа поля в SharePoint

Создание типа поля, унаследованного от типа Пользователь (User) с реализацией кастомного пикера (EntityPicker).

Шаг 1. Декларация своего типа поля

Все типы полей, используемые в SharePoint должны быть описаны в XML-файле (в одном или нескольких). Имя этого файла должно начинаться с fldtypes и располагаться он должен в папке %SharePointRoot%\TEMPLATE\XML. Типы полей SharePoint по умолчанию описаны в файле %SharePointRoot%\TEMPLATE\XML\fldtypes.xml.

Первое, что надо сделать, для создания своего типа поля - описать его. Для этого в проект добавим новую папку XML, сопоставленную с папкой SharePoint %SharePointRoot%\TEMPLATE\XML и создадим в ней XML-файл fldtypes_CustomUserField.xml (расширение здесь не важно, т.к. SharePoint при инициализации набора полей считывает все файлы, имена которых начинаются с fldtypes в независимости от их расширения). Так как новый тип поля будет унаследован от типа Пользователь(User), то для простоты просто выборочно воспроизведем описание этого поля по аналогии с родительским типом:

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <FieldTypes>
  3.   <FieldType>
  4.     <Field Name="TypeName">CustomUserField</Field>
  5.     <Field Name="ParentType">User</Field>
  6.     <Field Name="TypeDisplayName">Custom UserField</Field>
  7.     <Field Name="TypeShortDescription">Custom UserField</Field>
  8.     <Field Name="UserCreatable">TRUE</Field>
  9.     <Field Name="FieldTypeClass">$FieldClassFullName$</Field>
  10.     <Field Name="Sortable">TRUE</Field>
  11.     <Field Name="Filterable">TRUE</Field>
  12.     <Field Name="ShowInListCreate">TRUE</Field>
  13.     <Field Name="ShowInSurveyCreate">TRUE</Field>
  14.     <Field Name="ShowInDocumentLibraryCreate">TRUE</Field>
  15.     <Field Name="ShowInColumnTemplateCreate">TRUE</Field>
  16.     <Field Name="FieldEditorUserControl">/_controltemplates/UserFieldEditor.ascx</Field>
  17.   </FieldType>
  18. </FieldTypes>

Несколько слов о свойствах нового типа поля:

  • TypeName - текстовый идентификатор типа. Должен быть уникален в пределах фермы;
  • ParentType - указание на родительский тип. В нашем случае - User;
  • TypeDisplayName - имя типа поля, отображаемое в интерфейсе при добавлении нового столбца в список/библиотеку;
  • UserCreatable - показывать (TRUE) или нет (FALSE) тип поля в пользовательском интерфейсе;
  • FieldTypeClass - полное имя класса, описывающее поле;
  • FieldEditorUserControl - контрол, отображаемый на форме добавления столбца в список/библиотеку;

Эти свойства не наследуются от родительского типа, т.е. их значения надо явно указывать. FieldEditorUserControl контрол я указал стандартный. В одном из следующих постов я покажу как можно создавать и использовать свои свойства для типа поля. Описание остальных свойств можно найти на MSDN.

Шаг 2. Класс, описывающий тип поля

Теперь надо создать класс, описывающий новый тип поля, унаследовав его от класса Microsoft.SharePoint.SPFieldUser. Родительский класс SPFieldUser является модифицированной версией lookup-поля:

Для начала изменять функционал поля не будет, только переопределим свойство FieldRenderingControl, возвращающее контрол, инициализация которого необходима для отображения этого поля в интерфейсе пользователя.

Класс получился очень небольшим:

  1. public class CustomUserField : SPFieldUser
  2. {
  3.     public CustomUserField(SPFieldCollection fields, string fieldName)
  4.         : base(fields, fieldName)
  5.     {
  6.         Init();
  7.     }
  8.  
  9.     public CustomUserField(SPFieldCollection fields, string typeName, string displayName)
  10.         : base(fields, typeName, displayName)
  11.     {
  12.         Init();
  13.     }
  14.  
  15.     private void Init()
  16.     {
  17.         Type = SPFieldType.User;
  18.         TypeAsString = "CustomUserField";
  19.     }
  20.  
  21.     public override BaseFieldControl FieldRenderingControl
  22.     {
  23.         get
  24.         {
  25.             BaseFieldControl control;
  26.             if (CountRelated)
  27.             {
  28.                 control = new ComputedField();
  29.             }
  30.             else if (AllowMultipleValues)
  31.             {
  32.                 control = new CustomUserFieldControlMulti();
  33.             }
  34.             else
  35.             {
  36.                 control = new CustomUserFieldControl();
  37.             }
  38.             control.FieldName = InternalName;
  39.             return control;
  40.         }
  41.     }
  42. }

В конструкторе просто указываем тип нашего поля из enum'а SPFieldType (в моем случае SPFieldType.User), а также тип, который указан в XML определении нового типа ("CustomUserField") в поле TypeName.

В свойстве FieldRenderingControl логика предельно проста. Если поле является счетчиком ссылок на элемент (сопутствующий подсчет), то возвращаем стандартный контрол Microsoft.SharePoint.WebControls.ComputedField. В противном случае возвращаем свои контролы для lookup-поля с единственным и множественным значениями. Эти контролы необходимы для отображения своего пикера. В моем случае я создал два соответствующих контрола:

Можно использовать и стандартные контролы. При желании можно всегда выводить простой TextBox. Все упирается только в фантазию аналитика и бюджет проекта.

Шаг 3. Подготовка к пикеру

Для начала вернемся к свойству FieldRenderingControl. В случае, если множественный выбор не разрешен, то в качестве значения этого свойства будет возвращен экземпляр класса CustomUserFieldControl. Случай со множественным выбор я в посте описывать не буду, все это можно посмотреть в исходных кодах на CodePlex и SkyDrive.

Вот частично код класса CustomUserFieldControl:

  1. public class CustomUserFieldControl : UserField
  2. {
  3.     // Пикер
  4.     private CustomUserFieldPicker _picker;
  5.  
  6.     [SharePointPermission(SecurityAction.Demand, ObjectModel = true)]
  7.     protected override void CreateChildControls()
  8.     {
  9.         if (IsFieldValueCached)
  10.         {
  11.             base.CreateChildControls();
  12.         }
  13.         else if (Field != null)
  14.         {
  15.             if (ControlMode != SPControlMode.Display)
  16.             {
  17.                 // Иницализация пикера
  18.                 _picker = new CustomUserFieldPicker
  19.                           {
  20.                               MultiSelect = ((CustomUserField)Field).AllowMultipleValues
  21.                           };
  22.                 Controls.Add(_picker);
  23.                 // Задание значения
  24.                 SetFieldControlValue(Page.IsPostBack ? Value : ItemFieldValue);
  25.             }
  26.         }
  27.     }
  28.  
  29.     private void SetFieldControlValue(object value)
  30.     {
  31.         //...
  32.     }
  33.  
  34.     public override void Validate()
  35.     {
  36.         //...
  37.     }
  38. }

Простой контрол, унаследованный от Microsoft.SharePoint.WebControls.UserField, который добавляет на страницу пикер для задания значения поля, обеспечивает валидацию и прочее.

Шаг 4. Создание пикера (EntityPicker)

Класс нового поля создан, описание в виде XML-файла готово. Теперь можно переходить к реализации пикера. Сценарий использования нового типа поля будет следующим: выбор пользователей должен быть заменен на выбор сотрудников из соответствующего списка с возможностью поиска сотрудников по их принадлежности к структурному подразделению организации, для чего структура организации должна быть отображена в виде дерева в левой части диалогового окна. Теперь тоже самое в виде картинки:

Объектная модель будет использована описанная мною в постах о Linq to SharePoint.

Пикер в SharePoint 2010 состоит из следующий частей:

  • Сам пикер (EntityPicker). В нем должны быть реализованы методы для валидации введенных данных (метод ValidateEntity). поиска подходящих вариантов в случае ошибки при валидации (метод ResolveErrorBySearch). Также должен быть указан тип для диалога (свойство PickerDialogType);
  • Контрол поиска - строка поиска плюс выпадающий список;
  • Контрол отображения результатов - таблица (по умолчанию) с результатами поиска;

Пикер CustomUserFieldPicker унаследован от класса Microsoft.SharePoint.WebControls.PeopleEditor.

Пикер

Первое, что должно быть реализовано в пикере - валидация введенного значения. Для этого переопределяем метод ValidateEntity:

  1. public override PickerEntity ValidateEntity(PickerEntity entity)
  2. {
  3.     if (entity == nullreturn null;
  4.     if (entity.IsResolved) return entity;
  5.     var repository = new EmployeeRepository(true);
  6.     var filter = entity.DisplayText;
  7.     var emps = repository.GetEntityCollection(
  8.         x => x.Title.Contains(filter) || x.CellPhone.Contains(filter))
  9.         .Take(2)
  10.         .ToList();
  11.     if (emps.Count == 1)
  12.     {
  13.         entity = emps[0].ToPickerEntity();
  14.     }
  15.     else
  16.     {
  17.         entity.IsResolved = false;
  18.     }
  19.     return entity;
  20. }

Метод принимает объект типа PickerEntity. Если объекта нет, то возвращаем null. Если сущность уже валидна (IsResolved == true), то возвращаем её же. Далее создаем репозиторий для сотрудников и пробуем найти одного из них по введенному тексту (entity.DisplayText). В случае, если заданным критериям отвечает единственный сотрудник, создаем новый объект EntityPicker, используя следующий метод расширитель:

  1. public static PickerEntity ToPickerEntity(this ZhukDataItem value)
  2. {
  3.     return new PickerEntity
  4.                 {
  5.                     DisplayText = value.Title,
  6.                     IsResolved = true,
  7.                     EntityType = "ZhukDataItem",
  8.                     Key = value.Id.ToString()
  9.                 };
  10. }

В противном случае устанавливаем флаг IsResolved = false. Можно реализовать поиск по должности, тогда можно будет ввести "генеральный", вызвать валидацию и получить валидную сущность, представляющуу генерального директора (если других "генеральных" нет). Если сущность не прошла валидацию, то вызывается метод ResolveErrorBySearch для поиска подходящих вариантов:

  1. protected override PickerEntity[] ResolveErrorBySearch(string unresolvedText)
  2. {
  3.     var repository = new EmployeeRepository(true);
  4.     var emps = repository.GetEntityCollection(
  5.         x => x.Title.Contains(unresolvedText) || x.CellPhone.Contains(unresolvedText))
  6.         .ToList();
  7.     return emps.Select(x => x.ToPickerEntity()).ToArray();
  8. }

В этом методе все предельно просто. Ищем все, что удастся и возвращаем найденное.

Строка поиска

Класс, унаследованный от Microsoft.SharePoint.WebControls.SimpleQueryControl. Сначала избавимся от выпадающего списка возле строки поиска. Для этого воспользуемся свойством ColumnList, которое и является этим списком:

  1. protected override void CreateChildControls()
  2. {
  3.     base.CreateChildControls();
  4.     ColumnList.Visible = false;
  5. }

Со списком покончено. Теперь перед таблицей результатов поиска вставим свой UserControl, содержащий дерево, отражающее орг структуру организации ("/_CONTROLTEMPLATES/EmployeeFinder.ascx").

  1. private EmployeeFinder _finder;
  2.  
  3. protected override void CreateChildControls()
  4. {
  5.     base.CreateChildControls();
  6.     ColumnList.Visible = false;
  7.     // Загружаем контрол
  8.     _finder = Page.LoadControl("/_CONTROLTEMPLATES/EmployeeFinder.ascx"as EmployeeFinder;
  9.     if (_finder != null)
  10.     {
  11.         // Указываем экземпляр диалога
  12.         _finder.Dialog = PickerDialog;
  13.         // Находим контейнер для результатов поиска
  14.         var container = PickerDialog.ResultControl.Parent;
  15.         // Вставляем UserControl в начало
  16.         container.Controls.AddAt(0, _finder);
  17.         // Оборачиваем таблицу результатов в div для разметки страницы
  18.         container.Controls.AddAt(1, new LiteralControl(@"<div id=""DataTableContainer"">"));
  19.         container.Controls.AddAt(3, new LiteralControl(@"</div>"));
  20.     }
  21. }

Теперь перейдем к основному функционалу. Поиск:

  1. protected override int IssueQuery(string search, string groupint pageIndex, int pageSize)
  2. {
  3.     search = (search != null) ? search.Trim() : null;
  4.     if (string.IsNullOrEmpty(search))
  5.     {
  6.         PickerDialog.ErrorMessage = "Нечего искать";
  7.         return 0;
  8.     }
  9.     var repository = new EmployeeRepository(true);
  10.     var employees = repository.GetEntityCollection(
  11.         x => x.Title.Contains(search) || x.CellPhone.Contains(search))
  12.         .ToList();
  13.     if (employees.Count == 0)
  14.     {
  15.         PickerDialog.ErrorMessage = "Ничего не найдено";
  16.         return 0;
  17.     }
  18.     // Создаем таблицу и наполняем её
  19.     var table = CreateDataTable();
  20.     foreach (var employee in employees)
  21.     {
  22.         var row = table.NewRow();
  23.         row["Id"] = employee.Id;
  24.         row["Title"] = employee.Title;
  25.         row["DepartmentTitle"] = employee.DepartmentTitle;
  26.         table.Rows.Add(row);
  27.     }
  28.     PickerDialog.Results = table;
  29.     PickerDialog.ResultControl.PageSize = table.Rows.Count;
  30.     // Указываем параметры столбцов таблицы
  31.     var rc = PickerDialog.ResultControl as TableResultControl;
  32.     if (rc != null)
  33.     {
  34.         rc.ColumnNames.AddRange(new[] { "Id""Title""DepartmentTitle" });
  35.         rc.ColumnDisplayNames.AddRange(new[] { "ИД""ФИО""Отдел", });
  36.         rc.ColumnWidths.AddRange(new[] { "15%""50%""35%" });
  37.     }
  38.     // Возвращаем кол-во найденных элементов
  39.     return table.Rows.Count;
  40. }

И получение сущности из строки:

  1. public override PickerEntity GetEntity(DataRow dataRow)
  2. {
  3.     if (dataRow == null)
  4.         return null;
  5.     var entity = new PickerEntity
  6.     {
  7.         Key = Convert.ToString(dataRow["Id"]),
  8.         DisplayText = Convert.ToString(dataRow["Title"]),
  9.         Description = string.Empty,
  10.         IsResolved = true
  11.     };
  12.     entity.EntityData.Clear();
  13.     entity.EntityData.Add("DepartmentTitle", dataRow["DepartmentTitle"]);
  14.     return entity;
  15. }

Функционал в этих метод прост и, я думаю, дополнительные комментарии излишни.

Результаты поиска

В моем случае я использовал стандартный контрол. Можно реализовать свой, унаследовав его от типа Microsoft.SharePoint.WebControls.PickerResultControlBase.


Поделиться

Коментарии