Freigeben über

Field-Element (Feldtypen)

  • Artikel

Gilt für: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Repräsentiert ein Merkmal des Feldtyps.

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

Elemente und Attribute

In den folgenden Abschnitten werden Attribute, untergeordnete und übergeordnete Elemente erläutert.

Attribute

Attribut Beschreibung
Name Erforderlicher Text. Eine Zeichenfolge, die den Namen des angegebenen Aspekts des Feldtyps repräsentiert, den das Field-Element darstellt. Der Wert muss eine der Zeichenfolgen sein, die in der Tabelle unter Hinweise aufgeführt sind.

Untergeordnete Elemente

Keine

Übergeordnete Elemente

Hinweise

Untergeordnete Field-Elemente von FieldType-Elementen werden in fldtypes*.xml-Dateien in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML konfiguriert.

Jedes FieldType-Element verfügt über mehrere erforderliche und optionale Field-Elemente , die durch ihr Name-Attribut unterschieden werden. In der folgenden Tabelle werden diese Elemente beschrieben. Im Objektmodell wird ein Feldtyp durch die SPFieldTypeDefinition-Klasse dargestellt. Die letztere Klasse verfügt über eine schreibgeschützte Eigenschaft, die allen Zeilen der Tabelle bis auf zwei entspricht (die Ausnahmen sind InternalType und SQLType). Sofern nicht anders angegeben, stimmen die Eigenschaftennamen mit dem Wert des entsprechenden Name-Attributs überein.

Wert des Attributs des Feldelements Name Beschreibung
AllowBaseTypeRendering Optionaler Boolean-Wert. Der Standardwert ist FALSE. Gibt an, ob eine Clientanwendung das Feld als Basistyp (auch ParentType genannt) rendert, wenn die Clientanwendung nicht feststellen kann, wie der benutzerdefinierte Feldtyp ordnungsgemäß gerendert wird. Wenn true festgelegt ist und die Clientanwendung den benutzerdefinierten Feldtyp nicht ordnungsgemäß rendern kann, rendert die Clientanwendung das Feld als standardmäßigen übergeordneten SharePoint Foundation-Feldtyp, von dem es erbt.
CAMLRendering Optionaler Boolean-Wert. Der Standardwert ist FALSE. Gibt an, ob das Feld in Listenansichten mithilfe des CAML-Markups in einem RenderPattern-Element an anderer Stelle im übergeordneten FieldType-Element gerendert wird. Der Standardwert FALSE bedeutet, dass das Feld in Listenansichten von einer XSL-Transformation in einer fldtypes*.xsl-Datei gerendert wird. Dies ist das Standardsystem für das Rendern von Feldern in Listenansichten. (Dieses Element hat jedoch keine Auswirkungen auf das Rendern von Feldern in Formularen Anzeigen, Neu und Bearbeiten. Ein RenderPattern wäre weiterhin die Standardmethode zum Rendern des Felds in einem Anzeigeformular.)
FieldTypeClass Optionaler String-Wert, der jedoch für alle benutzerdefinierten Feldtypen erforderlich ist. Stellt den starken Namen der Feldtyp-Klassenbibliothek dar. FieldTypeClass enthält den Klassennamen und den Assemblynamen mit Version, Culture und PublicKeyToken. Zum Beispiel:
<Field Name="FieldTypeClass">CustomFieldTypes.RegularExpression.RegularExpressionField, CustomFieldTypes.RegularExpression, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57e55365ec0ce80a</Field>

Nur der vollqualifizierte Klassenname ist für in SharePoint Foundation integrierte Feldtypen enthalten.
FieldEditorUserControl Optionaler String-Wert. Stellt den relativen Pfad zu einer field_type FieldEditor.ascx-Datei dar, die ein Steuerelement definiert, das in SharePoint Foundation im Abschnitt Zusätzliche Spalteneinstellungen auf der Seite Neue Websitespalte angezeigt wird. Mit dem -Steuerelement können Spaltenersteller für eine bestimmte Spalte die Variableneigenschaften des Feldtyps festlegen.

Zum Beispiel:
"/_controltemplates/RegularExpressionFieldEditor.ascx".

Wenn kein <Field Name="FieldEditorUserControl"> Element vorhanden ist, werden die speziellen Eigenschaften des Feldtyps vom PropertySchema-Element (Field Types) -Element gerendert.

FieldEditorUserControl muss eine feste, nicht lokalisierbare Zeichenfolge sein.
Filterbar Erforderlicher Boolean-Wert. Gibt an, ob eine Liste mit einer auf diesem Feldtyp basierenden Spalte anhand des Werts der Spalte gefiltert werden kann, die diesen Typ verwendet. Bei TRUE ist die Spaltenüberschrift ein Steuerelement, das die Benutzer zum Filtern der Liste verwenden können.
InternalType Optionaler String-Wert. Repräsentiert einen internen Basistyp. Verwenden Sie kein <Field Name="InternalType"> -Element in Ihren benutzerdefinierten Feldtypdefinitionen.
ParentType Erforderlicher String-Wert (kann jedoch eine leere Zeichenfolge sein). Stellt den Namen des Typs dar, von dem die Feldklasse abgeleitet wurde. Die möglichen Werte sind identisch mit den möglichen Werten für das Type-Attribut des Field-Elements (List) -Elements. Wenn der Feldtyp nicht von einem anderen Typ abgeleitet ist, ist der Wert eine leere Zeichenfolge:
<Field Name="ParentType"> </Field>. Sie darf in Ihren benutzerdefinierten Feldtypen niemals leer sein. Alle benutzerdefinierten Typen erben von einem anderen Typ.

Im SharePoint Foundation-Objektmodell wird ParentTypeals BaseRenderingTypeName bezeichnet.
ShowOnListAuthoringPages Optionaler Boolean-Wert. Der Standardwert ist TRUE. Gibt an, ob dieser Feldtyp angezeigt wird, um in Listen eingebunden zu werden. Wenn dieser Wert auf TRUE festgelegt ist, zeigt SharePoint Foundation diesen Feldtyp auf Listenerstellungsseiten an, sodass Benutzer den Feldtyp in ihre Listen aufnehmen können.

Im SharePoint Foundation-Objektmodell heißt ShowOnListAuthoringPagesShowOnListCreate.
ShowOnDocumentLibraryAuthoringPages Optionaler Boolean-Wert. Der Standardwert ist TRUE. Gibt an, ob dieser Feldtyp angezeigt wird, um in Dokumentbibliotheken eingebunden zu werden. Wenn diese Einstellung auf TRUE festgelegt ist, zeigt SharePoint Foundation diesen Feldtyp auf Dokumentbibliothekserstellungsseiten an, sodass Benutzer den Feldtyp in ihre Dokumentbibliotheken einschließen können.

Im SharePoint Foundation-Objektmodell wird ShowOnDocumentLibraryAuthoringPages als ShowOnDocumentLibraryCreate bezeichnet.
ShowOnSurveyAuthoringPages Optionaler Boolean-Wert. Der Standardwert ist TRUE. Gibt an, ob dieser Feldtyp angezeigt wird, um in Umfragen eingebunden zu werden. Wenn diese Einstellung auf TRUE festgelegt ist, zeigt SharePoint Foundation diesen Feldtyp auf Den Seiten zur Erstellung von Umfragen an, sodass Benutzer den Feldtyp in ihre Umfragen einschließen können.

Im SharePoint Foundation-Objektmodell heißt ShowOnSurveyAuthoringPagesShowOnSurveyCreate.
ShowOnColumnTemplateAuthoringPages Optionaler Boolean-Wert. Der Standardwert ist TRUE. Gibt an, ob dieser Feldtyp als Spaltenvorlagen-Feldtyp angezeigt werden soll. Wenn dieser Wert auf TRUE festgelegt ist, zeigt SharePoint Foundation diesen Feldtyp auf Seiten zum Erstellen von Spaltenvorlagen an, sodass Benutzer auswählen können, ob eine Spaltenvorlage dieses Feldtyps erstellt werden soll.

Im SharePoint Foundation-Objektmodell wird ShowOnColumnTemplateAuthoringPages als ShowOnColumnTemplateCreate bezeichnet.
SQLType Optionaler String-Wert. Stellt den SQL-Datentyp dar, der zum Speichern der Daten in der Inhaltsdatenbank verwendet wird. Verwenden Sie kein <Field Name="SQLType"> -Element in Ihren benutzerdefinierten Feldtypdefinitionen.
Sortierbar Erforderlicher Boolean-Wert. Gibt an, ob eine Liste mit einer auf diesem Feldtyp basierenden Spalte anhand der Spalte sortiert werden kann, die diesen Typ verwendet. Bei TRUE ist die Spaltenüberschrift ein Steuerelement, das die Benutzer zum Sortieren der Liste verwenden können.
TypeDisplayName String erforderlich. Represents the display name of the field type in the user interface (UI). In SharePoint Foundation wird sie in der Spalte Typ auf der Seite [Liste] anpassen angezeigt (listedit.aspx). Es wird auch anstelle von TypeShortDescription verwendet, wenn letzteres nicht vorhanden ist.

TypeDisplayName sollte eine lokalisierbare Zeichenfolge sein.
TypeName String erforderlich. Stellt den Namen des Feldtyps dar. Es muss sich um einen eindeutigen Namen innerhalb aller Feldtypnamen in der SharePoint-Serverfarm handeln.

TypeName sollte eine feste, nicht lokalisierbare Zeichenfolge sein.
TypeShortDescription Optionaler String-Wert. Stellt die Kurzbeschreibung des Feldtyps dar, der auf der Benutzeroberfläche angezeigt wird. In SharePoint Foundation wird sie mit einem Optionsfeld im Abschnitt Name und Typ der Seiten Neue Websitespalte und Spalte erstellen sowie in der Spalte Typ des Websitespaltenkatalogs angezeigt. Wenn kein <Field Name="TypeShortDescription"> Element vorhanden ist, wird TypeDisplayName verwendet.

TypeShortDescription sollte eine lokalisierbare Zeichenfolge sein.
UserCreatable Optionaler Boolean-Wert. Der Standardwert ist TRUE, wodurch Benutzer Felder dieses Feldtyps listen hinzufügen können. Das Festlegen des Werts auf FALSE ermöglicht die Verwendung des Feldtyps in Listenschemas, blendet jedoch den Feldtyp für Benutzer im Abschnitt Name und Typ der Seiten Neue Websitespalte und Spalte erstellen aus.

Beispiel

Das folgende Beispiel definiert einen benutzerdefinierten Feldtyp.

Wichtig

Das RenderPattern-Element ist veraltet. Es wird hier nur gezeigt, um das Debuggen von benutzerdefinierten Feldern zu unterstützen, die ursprünglich für frühere Versionen von SharePoint Foundation entwickelt wurden.

<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>

Siehe auch