Элемент Field (Типы полей)

Статья
04/08/2023

Применимо к: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Представляет характеристику типа поля.

<Field Name="Text"></Field>

Элементы и атрибуты

В разделах ниже приводится описание атрибутов, дочерних и родительских элементов.

Атрибуты

Атрибут	Описание
Name	Обязательный текст. Строка, представляющая имя определенного аспекта типа поля, который представляет элемент Field. Значение должно быть одной из строк, перечисленных в таблице в разделе Примечания.

Дочерние элементы

Нет

Родительские элементы

Элемент FieldType (Field Types)

Замечания

Дочерние элементы полей элементов FieldType настраиваются в файлах fldtypes*.xml в папке %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML.

Каждый элемент FieldType содержит несколько обязательных и необязательных элементов Field , отличающихся атрибутом Name . В следующей таблице описаны эти элементы. В объектной модели тип поля представлен классом SPFieldTypeDefinition . Последний класс имеет свойство, доступное только для чтения, соответствующее всем строкам таблицы, кроме двух (исключениями являются InternalType и SQLType). За исключением случаев, когда указано иное, имена свойств соответствуют значению соответствующего атрибута Name.

Значение атрибута `Name` элемента Field	Описание
AllowBaseTypeRendering	Необязательный логический. Значение по умолчанию — FALSE. Указывает, выполняет ли клиентское приложение отрисовку поля в качестве базового типа (также называемого ParentType), если клиентское приложение не может определить, как правильно отобразить пользовательский тип поля. Если задано значение TRUE и клиентское приложение не может правильно отрисовать пользовательский тип поля, клиентское приложение отрисовывает поле как родительский тип поля SharePoint Foundation по умолчанию, от которого оно наследуется.
CAMLRendering	Необязательный логический. Значение по умолчанию — FALSE. Указывает, отображается ли поле в представлениях списка с помощью разметки CAML в элементе RenderPattern в другом месте родительского элемента FieldType . Значение FALSE по умолчанию означает, что поле отображается в представлениях списка с помощью преобразования XSL в файле fldtypes.xsl, который является стандартной системой для отрисовки полей в представлениях списка. (Однако этот элемент не влияет на отрисовку полей в формах Display, New и Edit. RenderPattern* по-прежнему будет стандартным способом отрисовки поля в форме отображения.)
FieldTypeClass	Необязательный атрибут String, но обязательный для всех типов настраиваемых полей. Представляет строгое имя библиотеки класса типа поля. FieldTypeClass включает имя класса и имя сборки с version, culture и PublicKeyToken; Например: `<Field Name="FieldTypeClass">CustomFieldTypes.RegularExpression.RegularExpressionField, CustomFieldTypes.RegularExpression, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57e55365ec0ce80a</Field>` Для типов полей, встроенных в SharePoint Foundation, включается только полное имя класса.
FieldEditorUserControl	Необязательный параметр String. Представляет относительный путь к файлу field_type FieldEditor.ascx, который определяет элемент управления, который отображается в SharePoint Foundation в разделе Дополнительные параметры столбца на странице Новый столбец сайта . С помощью элемента управления пользователи, создающие столбцы, могут указывать для конкретного столбца переменные свойства типа поля. Например: `"/_controltemplates/RegularExpressionFieldEditor.ascx"`. Если элемента нет`<Field Name="FieldEditorUserControl">`, специальные свойства типа поля отображаются элементом PropertySchema (Field Types). FieldEditorUserControl должна быть фиксированной нелокализуемой строкой.
Filterable	Обязательное типа Boolean. Указывает, может ли список со столбцом на основе данного типа поля быть отфильтрован в соответствии со значением столбца, использующего этот тип. Если задано значение TRUE, заголовком столбца является элемент управления, который можно использовать для фильтрации списка.
InternalType	Необязательное типа String. Представляет внутренний базовый тип. Не используйте `<Field Name="InternalType">` элемент в определениях настраиваемых типов полей.
ParentType	Обязательное типа String (но может быть пустая строка). Представляет имя типа, производным от которого является класс поля. Возможные значения точно совпадают с возможными значениями атрибута Typeэлемента Field (List). Если тип поля не является производным от другого типа, значением является пустая строка: `<Field Name="ParentType"> </Field>`. Он никогда не должен быть пустым в пользовательских типах полей. Все пользовательские типы наследуются от другого типа. В объектной модели SharePoint Foundation ParentType называется BaseRenderingTypeName.
ShowOnListAuthoringPages	Необязательный логический. Значение по умолчанию — TRUE. Указывает, отображается ли этот тип поля для включения в списки. Если задано значение TRUE, SharePoint Foundation отображает этот тип поля на страницах разработки списков, чтобы пользователи могли включить тип поля в свои списки. В объектной модели SharePoint Foundation showOnListAuthoringPages называется ShowOnListCreate.
ShowOnDocumentLibraryAuthoringPages	Необязательный логический. Значение по умолчанию — TRUE. Указывает, отображается ли этот тип поля для включения в библиотеки документов. Если задано значение TRUE, SharePoint Foundation отображает этот тип поля на страницах разработки библиотеки документов, чтобы пользователи могли включить тип поля в свои библиотеки документов. В объектной модели SharePoint Foundation showOnDocumentLibraryAuthoringPages называется ShowOnDocumentLibraryCreate.
ShowOnSurveyAuthoringPages	Необязательный логический. Значение по умолчанию — TRUE. Указывает, отображается ли этот тип поля для включения в исследования. Если задано значение TRUE, SharePoint Foundation отображает этот тип поля на страницах разработки опросов, чтобы пользователи могли включать этот тип поля в свои опросы. В объектной модели SharePoint Foundation ShowOnSurveyAuthoringPages называется ShowOnSurveyCreate.
ShowOnColumnTemplateAuthoringPages	Необязательный логический. Значение по умолчанию — TRUE. Указывает, должен ли этот тип поля отображаться в качестве типа поля шаблона столбца. Если задано значение TRUE, SharePoint Foundation отображает этот тип поля на страницах разработки шаблонов столбцов, чтобы пользователи могли создать шаблон столбца этого типа. В объектной модели SharePoint Foundation ShowOnColumnTemplateAuthoringPages называется ShowOnColumnTemplateCreate.
SQLType	Необязательный параметр String. Представляет тип данных SQL, используемый для хранения данных в базе данных контента. Не используйте `<Field Name="SQLType">` элемент в определениях настраиваемых типов полей.
Возможность сортировки	Обязательный атрибут типа Boolean. Указывает, может ли список со столбцом на основе данного типа поля быть отсортирован в столбце, использующем этот тип. Если задано значение TRUE, заголовком столбца является элемент управления, который можно использовать для сортировки списка.
TypeDisplayName	Обязательный атрибут типа String. Представляет отображаемое имя типа поля в пользовательском интерфейсе (UI). В SharePoint Foundation он отображается в столбце Тип на странице Настройка [список] (listedit.aspx). Он также используется вместо TypeShortDescription , если последний отсутствует. TypeDisplayName должен быть локализуемой строкой.
TypeName	Обязательный атрибут типа String. Представляет имя типа поля. Среди всех имен типов полей в ферме серверов SharePoint оно должно быть уникальным. TypeName должен быть фиксированной, нелокизируемой строкой.
TypeShortDescription	Необязательное типа String. Представляет краткое описание типа поля, отображаемого в пользовательском интерфейсе. В SharePoint Foundation он отображается с переключателем в разделе Имя и Тип страниц Новый столбец сайта и Создание столбца , а также в столбце Типколлекции столбцов сайта. Если элемента нет `<Field Name="TypeShortDescription">` , используется TypeDisplayName . TypeShortDescription должен быть локализуемой строкой.
UserCreatable	Необязательный логический. Значение по умолчанию — TRUE, что позволяет пользователям добавлять поля этого типа в списки. Установка значения FALSE позволяет использовать тип поля в схемах списков, но скрывает тип поля от пользователей в разделе Имя и Тип страниц Новый столбец сайта и Создание столбца .

Пример

В следующем примере определяется настраиваемый тип поля.

Важно!

RenderPattern устарел. Здесь показана исключительно помощь в отладке настраиваемых полей, которые изначально разрабатывались для более ранних версий SharePoint Foundation.

<FieldType>
  <Field Name="TypeName">SocialSecurityNumber</Field>
  <Field Name="ParentType">Text</Field>
  <Field Name="TypeDisplayName">Social Security Number</Field>
  <Field Name="TypeShortDescription">Social Security Number (123456789, 123-45-6789)</Field>
  <Field Name="AllowBaseTypeRendering">TRUE</Field>
  <Field Name="FieldTypeClass">
    AdventureWorks.FieldTypes.SPFieldSSN, AdventureWorks.FieldTypes.SPFieldSSN,
    Version=1.0.0.0,Culture=neutral,PublicKeyToken=90734cc53324b79c
  </Field>
  <RenderPattern Name="DisplayPattern">
    <Column HTMLEncode="TRUE" />
    <Column HTMLEncode="TRUE" UseRelatedField="TRUE"/>
  </RenderPattern>
</FieldType>

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