Добавление собственных столбцов в надстройки с размещением в SharePoint

Это третья часть серии статей, посвященной основам разработки надстроек SharePoint, размещаемых в SharePoint. Для начала вам следует ознакомиться со статьей Надстройки SharePoint и предыдущими статьями этой серии, представленными в разделе Знакомство с созданием надстроек SharePoint, размещаемых в SharePoint | Дальнейшие действия.

Примечание

Если вы изучали предыдущие статьи этой серии о надстройках, размещаемых в SharePoint, то у вас есть решение Visual Studio, которое можно использовать для продолжения работы с этой темой. Вы также можете скачать репозиторий по адресу SharePoint_SP-hosted_Add-Ins_Tutorials и открыть файл BeforeColumns.sln.

В этой статье мы вернемся к программированию и добавим несколько столбцов сайта в надстройку SharePoint Employee Orientation (Адаптация сотрудников).

Создание настраиваемых типов столбцов

  1. В обозревателе решений щелкните проект правой кнопкой мыши и выберите пункты Добавить > Новая папка. Присвойте папке имя Site Columns (Столбцы сайта).

  2. Щелкните правой кнопкой мыши новую папку и выберите пункты Добавить > Новый элемент. В узле Office/SharePoint откроется диалоговое окно Добавление нового элемента.

  3. Выберите пункт Site Column (Столбец сайта), присвойте столбцу имя Division (Подразделение) и нажмите кнопку Добавить.

  4. В файле elements.xml нового столбца сайта измените элемент Field так, чтобы он содержал атрибуты и значения, указанные в примере ниже. Не следует изменять идентификатор GUID атрибута ID (т. е удалять значение, созданное Visual Studio), поэтому будьте внимательны при копировании и вставке.

    <Field ID="{generated GUID}"
          Name="Division"
          Title="Division"
          DisplayName="Division"
          Description="The division of the company where the employee works."
          Group="Employee Orientation"
          Type="Text"
          Required ="FALSE">
    </Field>
    
  5. Добавьте другой столбец сайта с именем OrientationStage (Этап адаптации) в ту же папку.

  6. В файле elements.xml нового столбца сайта измените элемент Field так, чтобы он содержал атрибуты и значения, указанные в примере ниже, однако не меняйте GUID атрибута ID. Оставьте для него значение, созданное Visual Studio.

    <Field ID="{generated GUID}"
          Name="OrientationStage"
          Title="OrientationStage"
          DisplayName="Orientation Stage"
          Group="Employee Orientation"
          Description="The current orientation stage of the employee."
          Type="Choice"
          Required ="TRUE">
    </Field>
    
  7. Так как это поле является полем выбора (Choice), необходимо указать возможные варианты и порядок их отображения в раскрывающемся списке перед пользователем, который должен сделать выбор. Так как это поле обязательно для заполнения, необходимо указать значение по умолчанию. Добавьте приведенную ниже дочернюю разметку в элемент Field, а затем сохраните все файлы.

    <CHOICES>
        <CHOICE>Not Started</CHOICE>
        <CHOICE>Tour of building</CHOICE>
        <CHOICE>HR paperwork</CHOICE>
        <CHOICE>Corporate network access</CHOICE>
        <CHOICE>Completed</CHOICE>
    </CHOICES>
    <MAPPINGS>
          <MAPPING Value="1">Not Started</MAPPING>
          <MAPPING Value="2">Tour of building</MAPPING>
          <MAPPING Value="3">HR paperwork</MAPPING>
          <MAPPING Value="4">Corp network access</MAPPING>
          <MAPPING Value="5">Completed</MAPPING>
    </MAPPINGS>
    <Default>Not Started</Default>
    

Запуск надстройки и тестирование столбцов

  1. Нажмите клавишу F5, чтобы развернуть и запустить надстройку. Visual Studio выполнит временную установку надстройки на тестовом сайте SharePoint и сразу же запустит ее.

  2. Когда откроется страница надстройки по умолчанию, щелкните ссылку New Employees in Seattle (Новые сотрудники в Сиэтле), чтобы открыть экземпляр настраиваемого списка.

  3. Откройте страницу Параметры списка и добавьте в него два столбца, выполнив указанные ниже действия.

    1. Нажмите кнопку выноски · · · сразу над списком и выберите пункт Создать представление.

    2. Откроется страница Тип представления со структурой навигации Параметры > Тип представления рядом с верхней частью страницы. Щелкните Параметры.

      Рис. 1. Открытие страницы параметров списка

      Список новых сотрудников в Сиэтле с кнопкой выноски и элементом создания представления, выделенным как первый шаг. Еще указана стрелка на страницу создания представления с выделенной строкой навигации "Параметры".

    3. На странице Параметры щелкните ссылку Добавить из существующих столбцов сайта слева, примерно посередине страницы.

      Рис. 2. Страница "Параметры списка"

      Страница параметров экземпляра списка с выделенной ссылкой "Добавление столбцов из столбцов сайта".

    4. На странице Добавление столбцов из столбцов веб-сайта в раскрывающемся списке Выбрать столбцы сайта из щелкните Employee Orientation (Адаптация сотрудников).

      Рис. 3. Добавление столбцов из столбцов веб-сайта

      Элемент управления для выбора столбцов SharePoint. В раскрывающемся списке "Выбрать столбцы сайта" выбран пункт Employee Orientation (Адаптация сотрудников).

    5. Добавьте столбцы Division (Подразделение) и OrientationStage (Этап адаптации) в поле Столбцы для добавления.

    6. Нажмите кнопку ОК, чтобы вернуться на страницу Параметры, а затем щелкните New Employees in Seattle (Новые сотрудники в Сиэтле) в верхней части страницы.

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

    Рис. 4. Список с новыми столбцами

    Список с новыми столбцами Division (Подразделение) и Orientation Stage (Этап адаптации).

  5. Чтобы завершить сеанс отладки, закройте окно браузера или остановите отладку в Visual Studio. При каждом нажатии клавиши F5 Visual Studio будет отзывать предыдущую версию надстройки и устанавливать ее последнюю версию.

  6. Вы будете работать с этой надстройкой и решением Visual Studio при изучении других статей, поэтому при перерывах в работе рекомендуется отзывать надстройку. В обозревателе решений щелкните проект правой кнопкой мыши и выберите Отозвать.

Дальнейшие действия

На самом деле пользователям будет не очень удобно вручную добавлять настраиваемые столбцы в список, поэтому в следующей статье (Добавление настраиваемого типа контента в надстройку, размещаемую в SharePoint) этой серии описано, как создать настраиваемый тип контента, который включает в себя настраиваемые столбцы и автоматически сопоставляется с шаблоном списка New Employees (Новые сотрудники).