Поделиться через

Создание надстроек SharePoint в Visual Studio

  • Статья

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

Шаблоны проектов

При использовании шаблона проекта Visual Studio создает решение, которое содержит элементы проекта и файлы, необходимые для определенного типа проекта. Приведенные ниже шаблоны проекта отображаются в диалоговом окне Новый проект, если развернуть узел Office/SharePoint, а затем — узел Надстройки. Сведения о шаблонах проектов в узле Решения SharePoint см. в статье Шаблоны проектов и элементов проектов SharePoint.

Надстройка Office

Создает веб-страницу, которая размещается в приложении Office, таком как Excel или Outlook. Надстройка Office обеспечивает дополнительное содержимое и функциональные возможности в документе или элементе Outlook.

Дополнительные сведения см. в статье Обзор платформы надстроек Office.

Надстройка SharePoint

Создает Надстройка SharePoint на основе информации, которую вы указываете в мастере настройки. Эта информация включает в себя следующие данные:

  • Имя надстройки.
  • Локальный или удаленный сайт SharePoint, используемый для отладки надстройки.
  • Тип надстройки: с размещением у поставщика или в SharePoint.

Дополнительные сведения см. в статье Надстройки SharePoint.

Шаблоны элементов проектов

После создания решения SharePoint вы можете добавить в него элементы проекта с помощью следующих шаблонов, которые отображаются в диалоговом окне Добавление нового элемента в узле Office и SharePoint.

Надстройка Office

Добавляет надстройку Office в надстройку SharePoint. Вы можете добавить надстройку области задач, контентную или почтовую надстройку.

Дополнительные сведения см. в статье Обзор платформы надстроек Office.

Клиентская веб-часть (хост-сайт)

Добавляет клиентскую веб-часть в Надстройка SharePoint. Добавив клиентскую веб-часть, вы сможете отображать надстройки на страницах хост-сайта. Этот шаблон содержит один файл Elements.xml, свойства которого определяют следующие элементы клиентской веб-части.

Имя свойства Описание
ClientWebPart Определяет имя, заголовок, описание и размеры клиентской веб-части.
Контент Определяет расположение страницы, которая отображается в клиентской веб-части. У этого элемента есть два свойства: Type и Src.
Свойство Type определяет тип создаваемой веб-части, например HTML.
Свойство Src определяет расположение страницы, которая отображается в клиентской веб-части.
Шаблон ссылается на свойства в строке запроса, используя шаблон PropertyName, например Src="~addinWebUrl/Pages/ClientWebPart1.aspx?Property1=_property1_"

Дополнительные сведения см. в статье Создание веб-частей надстройки для установки с надстройкой SharePoint.

Тип контента

Добавляет тип контента в Надстройка SharePoint (как для типов контента, которые использовались в предыдущих версиях SharePoint). Тип контента представляет собой набор метаданных, рабочих процессов и режимов для категории элементов в списке или библиотеке SharePoint. Например, элемент — это один из типов списка контента. К другим типам списка контента относятся объявления, контакты и задачи, которые они наследуют данные от типа контента элемента. Тип контента контакта содержит столбцы, такие как Имя, Фамилия и Должность.

При добавлении типа контента в надстройку SharePoint указывается базовый тип контента, от которого наследуется новый тип контента. Например, последний может наследоваться от объявления, контакта, документа или элемента. После этого используется конструктор Тип контента для настройки столбцов и других свойств типа контента, например имени и описания. Выбранные значения добавляются в элементы ContentType и FieldRef в файле Elements.xml.

Дополнительные сведения см. в статье Стандартный блок: типы контента в SharePoint 2010.

Пустой элемент

Добавляет в Надстройка SharePoint элемент проекта для пустого элемента. Этот элемент проекта содержит один файл, Elements.xml, в котором вы определяете свойства элементов. Как правило, пустой элемент используется, чтобы определить компонент, для которого в Visual Studio нет шаблона.

Список

Добавляет в надстройку SharePoint два элемента: определение списка и его экземпляр. При добавлении списка в надстройку указывается его имя и тип (пустой или основанный на существующем типе списка). Кроме того, указывается, можно ли настраивать список. Затем используется конструктор списка для настройки столбцов и представлений списка, а также других свойств, например его имени и описания.

Дополнительные сведения о свойствах списка см. в статьях Элемент ListTemplate (List Template) и Элемент ListInstance (List Instance).

Добавляет элемент проекта, который расширяет пользовательский интерфейс хост-сайта путем добавления действия в меню списка. Дополнительное действие в меню содержит файл Elements.xml, который определяет свойства действия.

Дополнительные сведения см. в статье Создание дополнительных действий для развертывания с надстройками SharePoint.

Модуль

Добавляет элемент проекта модуля в Надстройка SharePoint. Модули это, по сути, контейнеры, которые можно использовать для добавления других файлов при развертывании Надстройка SharePoint. Для добавления файла скопируйте его в проект в модуле в Обозревателе решений. В файл Elements.xml для модуля будет автоматически добавлена ссылка на файл, которая указывает путь и URL-адрес нового файла. Вы можете удалить файл Sample.txt, который включен в модуль, так как он приведен только для примера.

Удаленный приемник событий

Добавляет в решение элемент проекта для удаленного приемника событий в надстройку SharePoint и проект веб-приложения, если такой проект еще не создан. Веб-приложение содержит веб-службу, связанную с удаленным приемником событий в надстройке SharePoint. Веб-служба включает файл кода Visual Basic или Visual C#, который выполняется, если в надстройке SharePoint возникает событие списка, элемента списка или веб-элемента. Если веб-приложение присутствует, оно связывается с надстройкой SharePoint, после чего в это приложение добавляется веб-служба.

Дополнительные сведения см. в статье Обработка событий в надстройках SharePoint.

Дополнительное действие на ленте

Добавляет элемент проекта, который расширяет пользовательский интерфейс хост-сайта путем добавления действия на ленту. Дополнительное действие на ленте содержит файл Elements.xml, который определяет свойства действия.

Дополнительные сведения см. в статье Создание дополнительных действий для развертывания с надстройками SharePoint.

Конфигурация поиска

Добавляет элемент проекта, который позволяет импортировать пользовательские параметры конфигурации поиска, экспортированные с сайта SharePoint.

Столбец сайта

Добавляет элемент проекта для столбца сайта в надстройку SharePoint. Столбец сайта содержит файл Elements.xml, который определяет свойства Field столбца сайта, включая вот какие данные:

Имя свойства Описание
ID Уникальный идентификатор GUID для столбца сайта.
Name Уникальное имя, которое используется для обращения к столбцу сайта.
DisplayName Понятное имя, которое отображается в пользовательском интерфейсе.
Тип Тип данных столбца сайта на основе SPFieldType, например логический, подстановка или текст.
Обязательный Если столбец является обязательным, то значение этого свойства True; в противном случае значение False.
Группа Указывает имя группы, которой назначен столбец сайта. Значение по умолчанию для этого свойства — Настраиваемые столбцы сайта.

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

Рабочий процесс

Добавляет элемент проекта для рабочего процесса Microsoft Azure в надстройку SharePoint. Дополнительные сведения см. в статье Рабочие процессы в SharePoint.

При добавлении этого типа элемента необходимо указать имя рабочего процесса, а также то, применяется ли он к списку или сайту. Как можно понять из имени этого типа, рабочий процесс списка работает только со списками, а рабочий процесс сайта — только с сайтами SharePoint. При создании рабочего процесса вы также указываете, следует ли автоматически привязывать процесс к спискам и библиотекам, и, если это так, то к каким. Для каждой добавленной вами связи в проект рабочего процесса добавляется файл. Рабочий процесс содержит вот какие файлы:

Имя файла Описание
Elements.xml Определяет конфигурацию рабочего процесса и файлов, которые он содержит, например файлы workflow.xaml и файлы связи, а также свойства каждого файла, например URL-адрес, тип и путь. Для каждого файла, который добавляется в рабочий проект, в файл Elements.xml для рабочего процесса будет добавлен также и соответствующий раздел. Для файлов связи в списке рабочих процессов требуется список для получения ссылки на маркер списка. Для рабочего процесса сайта добавляется GUID. Осторожностью Так как Visual Studio хранит элементы в файле Elements.xml, рекомендуется не изменять их, если вы не знакомы с влиянием изменений.
Workflow.xaml Представляет конструктор рабочего процесса. В этом файле вы добавляете в рабочий процесс действия, указываете их ​​код и свойства.
WorkflowStartAssociation Вручную запускает рабочий процесс в SharePoint. Этот файл будет добавлен в проект рабочего процесса при установке флажка Пользователь запускает рабочий процесс вручную в мастере создания рабочего процесса.
ItemAddedAssociation Запускает рабочий процесс автоматически при его наличии, если пользователь создает элемент на сайте или в списке (в зависимости от типа рабочего процесса). Этот файл будет добавлен в проект рабочего процесса при выборе флажка Рабочий процесс запускается автоматически при добавлении элемента в мастере создания рабочего процесса.
ItemUpdatedAssociation Запускает рабочий процесс автоматически при его наличии, когда пользователь изменяет элемент на сайте или в списке (в зависимости от типа рабочего процесса). Этот файл будет добавлен в проект рабочего процесса при выборе флажка Рабочий процесс запускается автоматически при изменении элемента в мастере создания рабочего процесса.
WorkflowHistoryList Представляет файл, который добавляется в рабочий проект, если вы создаете список журнала для рабочего процесса в мастере создания рабочего процесса.
WorkflowTaskList Представляет файл, который добавляется в рабочий проект, если вы создаете список задач для рабочего процесса в мастере создания рабочего процесса.

Дополнительное действие рабочего процесса

Добавляет элемент проекта для дополнительного действия рабочего процесса в надстройку SharePoint. Добавив такой действие, вы сможете создавать дополнительные действия в рабочем процессе, которые затем можно импортировать как дополнительные действия в SharePoint Designer. Дополнительное действие содержит файл Elements.xml, который определяет свойства действия, и XAML-файл для конструктора рабочих процессов.

Дополнительные сведения см. в статье Рабочие процессы в SharePoint.

См. также