Defines the internal data types used in the list infrastructure of a SharePoint Web site. A field is a column or attribute of information that a user can add to a list.
Attribute |
Description |
||
---|---|---|---|
Aggregation |
Optional Text. Used in an aggregate field on an XML form to specify the function to apply to a collection of values or elements returned by an XPath expression. If you use the Node attribute to specify an XPath expression that returns a collection of values, you can also include an Aggregation attribute that specifies the action to take on the value set that is returned. This action can be either an aggregation function or an indication of the particular element within the collection. Possible values include the following:
For more information about how the Node, PIAttribute, PITarget, PrimaryPIAttribute, and PrimaryPITarget attributes are used for property promotion and demotion in XML documents, see Using Content Types to Specify XML Document Properties. |
||
AllowDeletion |
Optional Boolean. TRUE if the field can be deleted. |
||
AllowHyperlink |
Optional Boolean. TRUE if hyperlinks can be used in the field. |
||
AllowMultiVote |
Optional Boolean. TRUE if multiple responses are allowed in a survey. |
||
AppendOnly |
Optional Boolean. When versioning is enabled in the list, TRUE if text can only be appended to existing text in the Note field. |
||
AuthoringInfo |
Optional Text. A descriptive string that is displayed in the field editing pages to identify the field and its purpose; for example, the LinkTitle field has the authoring info "(link to item)". This attribute is usually used if a field of the same name exists for another purpose. |
||
BaseType |
Optional. The BaseType attribute can be set to Integer, which stores values as integers, or to Text (default), which stores values as text. You cannot create integer base-type choice fields. |
||
CalType |
Optional Integer. Specifies the calendar type. Possible values include the following:
|
||
CanToggleHidden |
Optional Boolean. TRUE if the field can be hidden through the user interface. |
||
ClassInfo |
Optional Text. Specifies a cascading style sheet (CSS) class to use for the field in the standard table view. If set, the specified class is used instead of the standard ms-vb2 class. |
||
ColName |
Optional Text. An internal attribute that defines the mapping of the field to the physical storage name for this field. This must be a valid name in the underlying database and must be identical to the name used in the database table. If not specified, the server generates a column name that does not collide with any existing column names and that contains only characters that are allowed by Microsoft SQL Server. |
||
ColName2 |
Optional Text. |
||
Commas |
Optional Boolean. TRUE if commas are used to separate thousands. |
||
Customization |
Optional Text. |
||
Decimals |
Optional Integer. Determines the number of decimals to display. The value displayed is rounded up to the display precision; for example, 1.05 is displayed as 1.1 when rounded to one decimal place. |
||
Description |
Optional Text. Provides the description that is shown in the edit form for a list if a field description is specified. By default, fields in Microsoft SharePoint Foundation do not have descriptions. |
||
Dir |
Optional Text. Specifies the direction of text for a field that supports bidirectional reading order. The possible values are LTR (left-to-right), RTL (right-to-left), and none. |
||
Direction |
Optional Text. |
||
DisplaceOnUpgrade |
Optional Boolean. If a field definition already exists for the field, TRUE to force updates to field properties with the values that are specified in this field definition. |
||
DisplayImage |
Optional Text. Specifies the name of an icon that is displayed for the column. |
||
DisplayName |
Optional Text. The displayed name for a field. There is no restriction on text size or use of spaces. The display name can be edited by the user and can change after initial field creation. This name is used as a column heading when the field is displayed in a table view and as a form label when the field is displayed in a form. The |
||
DisplayNameSrcField |
Optional Text. Generally used for a computed field that needs the same name as another field. If the source field is modified and the display name is changed by a user, then the display name of this field will also change. This string refers to the name of the other field. |
||
DisplaySize |
Optional Integer. |
||
Div |
Optional Number. A scale factor used in division before displaying a number. The display number is N * Mult / Div (rounded up to the number specified by Decimals). |
||
EnableLookup |
Optional Boolean. TRUE to enable lookup values in the field. |
||
EnforceUniqueValues |
Optional Boolean. |
||
ExceptionImage |
Optional Text. Used in a Recurrence field type to specify the name of the image file to use for exceptions. |
||
FieldRef |
Optional Text. Specifies the name of another field to which the field refers, such as a Lookup field. |
||
FillInChoice |
Optional Boolean. TRUE if the field allows users to fill in values for the column. |
||
Filterable |
Optional Boolean. TRUE if the field can be filtered. |
||
FilterableNoRecurrence |
Optional Boolean. TRUE if a filter can be created on the field in a view that does not expand recurring events. If Filterable contains TRUE, the field can be filtered in all views regardless of how FilterableNoRecurrence is set. |
||
ForcedDisplay |
Optional Text. Specifies text to display in place of the actual field value. This attribute is used in surveys to prevent the user name from being displayed. |
||
ForcePromoteDemote |
Optional Boolean. |
||
Format |
Optional Text. Specifies the formatting to use for numerical values. For date/time fields, the following values are possible:
For Choice fields, this attribute can be set to Dropdown (default), which provides editing options through a drop-down selection, or to RadioButtons, which provides options through a group of radio buttons. For URL fields, this attribute can be set to Hyperlink (default), which displays the URL as a normal tag, or to Image, which displays the URL as . |
||
FromBaseType |
Optional Boolean. This attribute is deprecated in favor of the Sealed attribute. |
||
Group |
Optional Text. Specifies the column group to which the field belongs. |
||
HeaderImage |
Optional Text. Specifies the name of an image file to use as a header in the field. |
||
Height |
Optional Integer. Specifies the height in pixels of the images that are displayed for users in the User Information list. |
||
Hidden |
Optional Boolean. If TRUE, the field is completely hidden from the user interface. Setting ReadOnly to TRUE means the field is not displayed in New or Edit forms but can still be included in views. |
||
HTMLEncode |
Optional Boolean. TRUE to convert embedded characters so that they are displayed as text in the browser; characters that could be confused with HTML tags are converted to entities. |
||
ID |
Optional Text. Specifies the GUID of the field contained within braces ({}). |
||
Id |
Optional Text. |
||
IMEMode |
Optional Text. Specifies the Input Method Editor (IME) mode bias to use for the field. The IME allows for conversion of keystrokes between languages when one writing system has more characters than can be encoded for the given keyboard. Possible values include the following:
|
||
Indexed |
Optional Boolean. TRUE if the column is indexed for use in view filters. |
||
IsolateStyles |
Optional Boolean. For a Text field whose RichText attribute is TRUE and whose RichTextMode attribute is FullHtml, this attribute specifies that a server will rewrite the HTML of the field to ensure that it will not interfere with the rendering of the surrounding page. |
||
IsRelationship |
Optional Boolean. TRUE if the field is discoverable from the list to which it looks for its value. |
||
JoinColName |
Optional Text. This attribute is defined only for Lookup fields. It is very similar to ColName, except it denotes the name of the column that is used in the SQL JOIN between the local and external lists. Ordinarily, this value should not be customized. It is currently used only in the Field schema of certain built-in and base type fields to denote lookups into the URLs (DocMd) table, which is joined on the UrlID column. |
||
JoinRowOrdinal |
Optional Integer. Not intended to be used directly from your code. |
||
JoinType |
Optional Text. Specifies the type of JOIN used on the field. Possible values include INNER, LEFTOUTER, and RIGHTOUTER. |
||
LCID |
Optional Integer. The LCID attribute can be used to specify the country/region whose currency format is being used, for example, 1033 for the United States. Two special cases involve the euro symbol format. If LCID = -1 (0xFFFFFFF), the euro symbol is added as a prefix to the number. If LCID = -2 (0xFFFFFFE), the euro symbol is added as a suffix to the number. The number of decimal digits is 2, although this can be overridden by the Decimals attribute of the field. The euro currency symbol is equal to 0x20AC in UCS-2. |
||
LinkToItem |
Optional Boolean. |
||
LinkToItemAllowed |
Optional Text. |
||
List |
Optional Text. Specifies the internal name of a list. |
||
ListItemMenu |
Optional Boolean. |
||
ListItemMenuAllowed |
Optional Text. |
||
Max |
Optional Number. Specifies the maximum value allowed for the field. |
||
MaxLength |
Optional Integer. Specifies the maximum number of characters allowed in a field value. Edit forms are adjusted to enforce this value, which is validated on the client. If the user attempts to enter more than the number of characters set by MaxLength, an error message appears. |
||
Min |
Optional Number. Specifies the minimum value allowed for the field. |
||
Mult |
Optional Boolean. A scale factor used in multiplication before displaying a number. |
||
Name |
Required Text. The name of a field. This is the internal name of a field and is guaranteed never to change for the lifetime of the field definition. It must be unique with respect to the set of fields in a list. The name is autogenerated based on the user-defined name for a field. |
||
NegativeFormat |
Optional Text. Specifies how to indicate negative values. Can be set to one of the following values:
|
||
Node |
Optional Text. Used in XML forms, this attribute is required for all fields except processing instruction (PI) links, and it specifies the XPath expression for a node that is promoted. |
||
NoEditFormBreak |
Optional Boolean. TRUE to prevent a line break from being added between fields in the new item form or edit item form. Some field types, such as a rich-text field, provide spacing by default, and this attribute allows control over the extra spacing that results. |
||
NumLines |
Optional Integer. Recommends the number of lines (rows) to display in a TEXTAREA block during editing. This is merely a client UI hint—there is no enforced limitation on the number of lines of text that can be edited. |
||
Percentage |
Optional Boolean. TRUE if the value is displayed as a percentage; that is, a number multiplied by 100 with a percent sign (%) appended. |
||
PIAttribute |
Optional Text. Specifies the attribute in the document processing instruction (specified by the PITarget attribute) to use as the column value. Used for property promotion and demotion in XML documents. If you specify the PIAttribute attribute, you must also specify the PITarget attribute. For more information about how the Node, PIAttribute, PITarget, Primary PIAttribute, and PrimaryPITarget attributes are used for property promotion and demotion in XML documents, see Using Content Types to Specify XML Document Properties. |
||
PITarget |
Optional Text. Specifies the document processing instruction in which the column value is stored in documents of this content type. Used for property promotion and demotion in XML documents. If you specify the PIAttribute attribute, you must also specify the PITarget attribute. For more information about how the Node, PIAttribute, PITarget, Primary PIAttribute, and PrimaryPITarget attributes are used for property promotion and demotion in XML documents, see Using Content Types to Specify XML Document Properties. |
||
PrependId |
Optional Boolean. Used in Issue Tracking lists, TRUE to display the collection IDs of related issue items in Edit and New item forms. |
||
Presence |
Optional Boolean. TRUE if user information is present for the field. |
||
PrimaryKey |
Optional Boolean. TRUE if the field is the primary key in the relationship between the list and another list. |
||
PrimaryPIAttribute |
Optional Text. Used for property promotion and demotion in XML documents. Specifies an alternate attribute in the document processing instruction, specified by the PrimaryPITarget, to use as the column value. If you specify the PrimaryPIAttribute attribute, you must also specify the PrimaryPITarget attribute. If specified, SharePoint Foundation uses these values before those specified in the PITarget and PIAttribute attributes. For more information about how the Node, PIAttribute, PITarget, Primary PIAttribute, and PrimaryPITarget attributes are used for property promotion and demotion in XML documents, see Using Content Types to Specify XML Document Properties. |
||
PrimaryPITarget |
Optional Text. Specifies an alternative document processing instruction in which the column value is stored for documents of this content type. If you specify the PrimaryPIAttribute attribute, you must also specify the PrimaryPITarget attribute. If specified, SharePoint Foundation uses these values before those specified in the PITarget and PIAttribute attributes. For more information about how the Node, PIAttribute, PITarget, Primary PIAttribute, and PrimaryPITarget attributes are used for property promotion and demotion in XML documents, see Using Content Types to Specify XML Document Properties. |
||
ReadOnly |
Optional Boolean. If TRUE, the field is not displayed in New or Edit forms but can be included in views. In addition, setting ReadOnly to TRUE hides the field from Site Settings pages for managing site columns and content types. Setting the Hidden attribute to TRUE completely hides the field from the UI. If you do not include this attribute, SharePoint Foundation treats the column as if this attribute is set to False. |
||
ReadOnlyEnforced |
Optional Boolean. TRUE to specify that the user cannot change the field by any means and that it can only be changed by the system. |
||
RelationshipDeleteBehavior |
Optional Text. Specifies the delete behavior of the field. Possible values include Cascade, Restrict and None. |
||
RenderXMLUsingPattern |
Optional Boolean. Used for computed fields to determine the display format. If TRUE, values are rendered based on the display pattern of the computed field, rather than on the column value of the first noncomputed field reference upon which the computed field is based. For example, in a picture library, the Picture Size column is represented by width x height, but if this attribute is not set to TRUE, only the first field reference, width, is displayed. If it is set to TRUE, the format of width x height is displayed. |
||
Required |
Optional Boolean. If TRUE, the field must not have an empty value assigned to it. If a nonempty field value is not given in a form post, either the standard required-field text or an explicitly specified message (that is, via |
||
RestrictedMode |
Optional Boolean. TRUE to not allow the Note field to contain enhanced rich text formatting, such as pictures, tables, or hyperlinks, nor to allow pasting formatted text into the field. |
||
ResultType |
Optional Text. Specifies the data type of values that are returned from the field. |
||
RichText |
Optional Boolean. TRUE if the field displays rich text formatting. |
||
RowOrdinal |
Optional Integer. Specifies the database location for the field. |
||
Sealed |
Optional Boolean. Setting this attribute to TRUE for a field in the Schema.xml file for a list marks the field as irremovable in the Change Column page. |
||
SeparateLine |
Optional Boolean. Used internally to support rendering a field (for example, Notes or Comment) in a separate line. This attribute is not intended for public use. |
||
SetAs |
Not intended to be used directly from your code. |
||
ShowAddressBookButton |
Not intended to be used directly from your code. |
||
ShowAlways |
Optional Boolean. |
||
ShowField |
Optional. The ShowField attribute can be set to the field name to be displayed. By default, a hyperlinked text from the Title field of the record in the external list is displayed. But the ShowField attribute can be used to override that and display another field from the external list. The following data types are allowed as targets of a ShowField attribute: Text, Choice, and Counter. For a Lookup field, this parameter must be set to the internal field name; setting it to the display name does not raise an error, but breaks the field. |
||
ShowInDisplayForm |
Optional Boolean. TRUE to display the field in the form for viewing the item. |
||
ShowInEditForm |
Optional Boolean. TRUE to display the field in the form for editing the item. |
||
ShowInFileDlg |
Optional Boolean. This attribute is valid only for fields within document library schemas. If FALSE, the field does not show up in the property dialog box for saving forms that appears when saving from client applications. For example, the Title field has this attribute because this is set directly in the document being saved to the document library. |
||
ShowInListSettings |
Optional Boolean. TRUE to display the column on the page for customizing list settings. |
||
ShowInNewForm |
Optional Boolean. If FALSE, the field does not show up in a Fields enumeration when the display mode is set to New. Fields with this setting do not show up in the default New Item page for a given list. In particular, this is used to hide fields on the page for uploading documents to the document library. |
||
ShowInVersionHistory |
Optional Boolean. TRUE to display the column on the page for viewing list item versions. |
||
ShowInViewForms |
Optional Boolean. TRUE to specify that the field is displayed in pages that are used to view list data. |
||
Sortable |
Optional Boolean. TRUE if values in the field can be sorted. |
||
SourceID |
Optional Text. Contains the namespace that defines the field, such as http://schemas.microsoft.com/sharepoint/v3, or the GUID of the list in which the custom field was created. |
||
StaticName |
Optional Text. Contains the internal name of the field. |
||
StorageTZ |
Specifies how date/time values are stored. When StorageTZ is set to UTC, the date/time is handled as Coordinated Universal Time (UTC). To denote that a date/time value refers to "abstract" time, meaning that the date/time is stored in the database as entered by the user without conversion or storage of the local time zone, omit the StorageTZ attribute. |
||
StripWS |
Optional Boolean. TRUE if white space is removed from the beginning and end of field values. |
||
SuppressNameDisplay |
Optional Boolean. TRUE to not display the name of the user in a User field. |
||
TextOnly |
Optional Boolean. If TRUE, the field can contain only Text values. |
||
Title |
Optional Text. Contains the title of the field that is displayed in the user interface. |
||
Type |
Required Text. The data type of the field (unless the Field element is a child of ProjectedFields).
SharePoint Foundation includes the following data types by default:
|
||
UniqueId |
Optional Text. Not intended to be used directly from your code. |
||
UnlimitedLengthInDocumentLibrary |
Optional Boolean. TRUE to allow unlimited field length in document libraries. |
||
URLEncode |
Optional Boolean. TRUE to convert special characters, such as spaces, to quoted UTF-8 format, for example, %c3%ab for character ë. |
||
URLEncodeAsURL |
Optional Boolean. Like URLEncode, but TRUE to specify that the string to encode is a path component of a URL so that forward slashes ("/") are not encoded. |
||
UserSelectionMode |
Optional Text. Specifies whether only the names of individual users can be selected in a user field on an item form, or whether the names of both individuals and groups can be selected. The following values are possible: 0 - Only the names of individuals can be selected. 1 - The names of both individuals and groups can be selected. |
||
UserSelectionScope |
Optional Integer. Specifies a scope for selecting user names in a user field on an item form. If the value is 0, there is no restriction to a SharePoint group. If the value is greater than 0, user selection is restricted to members of the SharePoint group whose ID equals the value that is specified. |
||
Version |
Optional Text. |
||
Viewable |
Optional Boolean. TRUE to specify that the field is added to the default view. The default value is TRUE. |
||
WebId |
Optional Text. |
||
Width |
Optional Integer. Specifies the width in pixels of the images that are displayed for users in the User Information list. |
||
WikiLinking |
Optional Boolean. TRUE to specify that wiki links, which appear in the form of double brackets ([[…]]), become translated into HTML links, which use the tag. |
||
XName |
Optional Text. Used internally in XML forms to identify fields that have been added, deleted, or modified. This attribute is not intended for public use. |
CHOICES, Customization, Default, DefaultFormula, DisplayBidiPattern, DisplayPattern, FieldRefs, Formula, FormulaDisplayNames, MAPPINGS, Validation |
Fields, ProjectedFields |
Minimum: 0 Maximum: Unbounded when the parent is Fields. When the parent is ProjectedFields the maximum is difference between the maximum number of allowed fields in the primary list that is being queried and the number of fields already in the list. |
To create a custom field definition for a list definition that is based on a default SharePoint Foundation field type, use the Field (List - Definition) element within a Schema.xml file. To create a custom field definition as a pluggable Feature that is based on a default field type and that can be reused across Web sites and lists within a site collection, use the Field (Field) element to define a custom site column. To create a custom field type that implements a custom class for special data validation and field rendering, use the Field (Field Types) element.
Fields can be referenced from View definitions as well as from expressions in computed field rendering elements. Use the Field (View) element to return a formatted field value for display within a view, and use the Column (View) element to return the raw data value of the field. The syntax for referencing a field is as follows:
By default, the field is rendered with the default attributes for that field definition as specified in the previous table. Any of the field attributes can be overridden in the CAML markup of the FieldRef attribute, which overrides the definition given for the field itself. (The Type attribute for a field cannot be changed.)
Within a Fields element enumeration, the Name attribute can be omitted. For some field references, the raw data stored for the field can be accessed by using
Some properties of fields from forms and from certain aspects of the authoring UI can be rendered through the Property element, for example,
In addition to the preceding types, the following predefined fields are used with the Field element.
Name |
Description |
---|---|
Created |
A field that contains a DateTime value specifying the time that the item was created (in UTC). |
CreatedBy |
A field that contains a Lookup value that refers to the UserInfo table and indicates the user who created the item. |
Edit |
A Computed field (with no additional schema) that contains a hyperlink to the form for editing an item. This field references the page for editing the item and the ID field to identify it. |
ID |
A Counter field type that is associated with every item in every list. The ID uniquely identifies the list item in URLs and in POST forms when editing. Specifying New as the value of the ID attribute in the Cmd=Save command creates an item rather than edits a current item. |
Modified |
A field that contains a DateTime value specifying the time that the item was last modified (in UTC). The Modified time is used as a sort of Version field as well. The last modification date of an item is always posted when an existing item is being edited. If it does not match the current modification date, the server fails the edit and returns an error to the user, providing a link to the current data on the server (which opens in a new window), so that posted values can be copied from the old form into the new one. |
ModifiedBy |
A field that contains a Lookup value to the UserInfo table indicating the user who last modified the item. |
Title |
The generic display name of every item. It may have a different display name in different lists but the same internal field name of Title. The title is the default text to display for Lookup fields to lists. |
LinkTitle |
A computed field that displays hyperlinks to items, containing the title texts and generating URLs (and new icon references) to the items. There is no additional storage for this field; it relies on the ID and Title fields for rendering of its UI. |
Note |
---|
The fields returned in a Fields enumeration are affected by the display mode. Fields that are marked with the Hidden attribute are never returned. Fields that are marked with the ReadOnly attribute are not returned if a form is being rendered (if Fields is called from within a ListForm element). Fields that are marked with the ShowInNewForm attribute are not returned in the NEW or PREVIEWNEW display modes. Fields marked with the ShowInFileDlg attribute are not returned when rendering the NewForm dialog form. |
The following example uses the Field element to specify options for a list named Area list.
Views Site Design Layouts Schema Design Fields Forms Projects Inter-Team Issues Schedule Spec Headcount Misc