Share via

2.2.8.3.3.2 Attributes

  • Article

Aggregation: For fields with the Node or node attribute, a reader MUST use this attribute to control promotion from XML or site template files. For other fields, a reader MUST ignore this attribute.

aggregation: For fields whose Type attribute maps to the Note field (2) internal type, the reader MAY permit a filtering user interface if this attribute contains the value merge (with case-insensitive comparison<4>). Otherwise a reader MUST ignore this attribute. A writer SHOULD NOT include this attribute.

AllowDeletion: If this attribute is FALSE, then the server MUST NOT permit the field (2) to be removed from the schema of a list.

AllowHyperlink: For fields whose Type maps to the Note field (2) internal type, and for which RichText is TRUE and RichTextMode is Compatible, a reader can use this attribute to determine if the editing UI allows insertion of hyperlinks. If this attribute is TRUE, a server or client presenting an editing user interface for this field (2) MUST include the insert hyperlink command. Otherwise, the editing user interface MUST NOT include the insert hyperlink command.

AllowMultiVote: The reader MUST ignore this attribute.

AppendOnly: If TRUE, for fields whose Type maps to the Note field (2) internal type, a client or server which presents a way of editing the value for this field (2) MUST do so in a way that ensures preservation of old data in the field (2).

AuthoringInfo: Text describing the field (2) to schema authors. A client or server presenting a schema-editing UI can display the text in this attribute.

BaseRenderingType: Field internal type that the server uses to render a field (2). If not present, the Type attribute does not map to an internal type in a way suitable for rendering. The server MUST derive the value of this attribute from the Type attribute, overriding the client-specified value.

BaseType: Allows a schema author to override the internal storage format for choice fields. A reader MUST ignore this attribute unless the field's internal type is Choice, MultiChoice, or GridChoice. A writer MUST NOT set this attribute's value to Choice, MultiChoice, or GridChoice.

CalType: Associates a calendar type with a field (2). A reader SHOULD take this value into consideration when rendering the field or performing date calculations on it. If this attribute is not present, a reader MUST use the CalendarType attribute. If that is also not present, it SHOULD fall back to the user's preference, and if that is not specified, to the calendar type for the site.

CalendarType: This is equivalent to CalType. A reader MUST use the value of CalType if present, but if that attribute is not present, it MUST use this attribute for the same purpose. A writer SHOULD omit this attribute, using CalType instead where it is needed.

Calculated: The reader MUST ignore this attribute.

CanToggleHidden: If TRUE, a server MUST permit the user to change the value of the Hidden attribute. Otherwise, a server MUST prevent the Hidden attribute from changing.

CountRelated: If TRUE, the internal type of the field (2) MUST be Lookup, the List and FieldRef attributes of the field MUST refer to a field of internal type Lookup, and for the referred field, its List attribute MUST refer to the list of which the source field is a member. A writer MUST NOT include this attribute if the Mult attribute is present. A reader MUST ignore the attribute if the field (2) internal type of the field is not Lookup.

ClassInfo: A writer SHOULD use values Menu or Icon, or it SHOULD omit the attribute. When rendering the value of the field (2) in a view, a server SHOULD use this to format the field appropriately for a menu or an icon. The server MUST ignore values other than Menu or Icon and MUST fall back to the default behavior for other values.

ColName: A server SHOULD use this attribute to describe the physical storage location for the field (2). A client MUST ignore this attribute and a server MUST pick its own value for this attribute when accepting CAML from a client.

ColName2: This has the same restrictions and semantics as the ColName attribute except it describes a secondary physical storage location.

Commas: A writer SHOULD NOT use this attribute; a reader MUST ignore this attribute.

Customization: A writer SHOULD NOT use this attribute; a reader MUST ignore this attribute.

Decimals:  The number of digits to render in the fractional part of a number. A writer SHOULD only use this attribute on fields whose field (2) internal type is Number or Calculated. The reader MUST ignore this attribute on files with other internal types. A writer SHOULD omit this attribute rather than write the default value of "-1". When rendering a numeric field (2), a server MUST use this attribute to determine the number of decimal places to render. For the special value of -1, trailing zeros MUST be omitted.

DefaultURLDesc: For a field (2) whose field internal type is URL, this is the value to use for the description part when the user does not provide a description. The default is to use the URL part of the field (2). If the field's internal type is not URL, a reader MUST ignore this attribute.

Description: Textual description of the field (2) to be displayed in the user interface for schema authoring.

Direction: Specifies that HTML field (2) rendering will be done in left-to-right, right-to-left, or in the ambient context of the surrounding page.

Dir: A writer SHOULD NOT use this attribute; a reader MUST ignore this attribute.

DisplaceOnUpgrade: When TRUE, indicates that a server depends on the name of a field (2). The client MUST NOT set this attribute.

DisplayImage: When specified, this attribute supplies the URL, relative to the server's /_layouts/images folder, to render when displaying the field (2). A reader MUST ignore this attribute except for CrossProjectLink fields and Recurrence fields. If not specified, a blank placeholder image is used instead.

DisplayName: The text to display in the user interface when referring to the field (2).

DisplayNameSrcField: When present, specifies the name of another field (2) on the list to which the DisplayName of the current field is synchronized.

DisplaySize: Number of columns to offer when displaying the field (2).

Div: In fields whose field (2) internal type is Integer, Number, or Calculated, a reader MUST interpret this as a floating point number by which the value is divided at render time. In fields of other internal types, a reader MUST ignore this attribute and a writer MUST NOT include this attribute.

EnableLookup: Specifies whether the user interface for creating a Lookup field (2) lists a Computed field as a possible target for the lookup. Unless the target field (2) type is Computed, a writer SHOULD NOT include this attribute and a reader MUST ignore it.

ExceptionImage: Specifies an image to display in place of DisplayImage for recurrence fields for items that are exceptions to the recurrence. A writer MUST include this attribute for recurrence fields if the DisplayImage is also included and MUST NOT include it otherwise.

Ext: A writer SHOULD only include this attribute when the Format attribute is set to Telephone. A reader MUST ignore this unless the Format is set to Telephone.

FieldRef: When present on a Lookup field (2), specifies the Name of another field on the list from which to obtain the local value for the lookup. Lookup fields for which this attribute is not specified will supply their own storage for the local value.

FillInChoice: Specifies whether or not a form generated to let the user edit a choice field (2) or multichoice field allows values other than those listed in the CHOICES child element. A reader MUST ignore this attribute except for the Choice fields and MultiChoice fields.

Filterable: Specifies whether items can be omitted or included from the results of a query based on the value of the field (2). TRUE if the field can be filtered; FALSE otherwise.

FilterableNoRecurrence: When TRUE, and the Filterable attribute is FALSE, specifies that items can be included or omitted from the results of a query in views that do not expand recurring events.

ForcedDisplay: If present, specifies a value for the field (2) to display in place of the field's real value.

Format: Specifies how to render the field (2). The interpretation of this attribute and the range of legal values depend on the value of the Type attribute, as follows:

  • For a datetime field (2), the value MUST be DateTime, DateOnly, TimeOnly, ISO8601, ISO8601Basic, ISO8601Gregorian, or not present. A reader MUST interpret a missing attribute to mean DateTime.

  • For a Choice field (2), the value MUST be DropDown, RadioButtons, Checkbox, or not present. A reader MUST interpret a missing attribute to mean DropDown.

  • For a CrossProjectLink field (2), the value MUST be EventList or not present.

  • For URL fields, the value MUST be Image, Hyperlink, or not present. A reader MUST interpret a missing attribute as Hyperlink.

  • For a Text field (2), the value MUST be Telephone or not present. The value Telephone indicates that the edit form of the field is to be rendered in a way to facilitate entry of telephone numbers. The absence of the attribute indicates no special editing mode.

  • For a Boolean field (2), the value MUST be CheckboxIcons, CheckboxIconsWithHeaderIcon, or not present.

  • A reader MUST ignore this attribute for other field (2) types.

FromBaseType: Indicates that the field (2) was inherited from the list's base type. If TRUE, a server prevents the field from being deleted or having its type changed.

GridEndNum: Specifies the largest choice possible in a GridChoice field (2). A writer MUST include this attribute for GridChoice fields. A reader MUST ignore this attribute for other field types.

GridNATxt: A textual value to render for the choice that indicates "not applicable" in a GridChoice field (2). A reader MUST ignore this attribute for fields of other types.

GridStartNum: Specifies the smallest choice possible in a GridChoice field (2). A writer MUST include this attribute for GridChoice fields. A reader MUST ignore this attribute for fields of other types. A writer SHOULD set the value of this attribute to 1.

GridTxtRng1: A textual value to render for the choice that indicates the value corresponding to that which is specified by the GridStartNum attribute in a GridChoice field (2). A reader MUST ignore this attribute for other field types.

GridTxtRng2: A textual value to render for the choice that indicates the middle value in a GridChoice field (2). A reader MUST ignore this attribute for other field types.

GridTxtRng3: A textual value to render for the choice that indicates the value corresponding to that specified by the GridEndNum attribute in a GridChoice field (2). A reader MUST ignore this attribute for fields of other types.

Group: Name of the field (2) that is used for grouping purposes. A reader MUST take a localized version of "Custom Columns" as the default value for this attribute.

HeaderImage: Specifies a URL, relative to the /_layouts/images folder on the server, to render in place of the field's DisplayName in views and forms.

Height: Height in pixels to render an image for a URL field (2) whose Format attribute is equal to Image. If not present, specifies that the target image does not need to be scaled.

A reader MUST ignore this attribute, except for URL fields where the Format attribute specifies Image and the Width attribute is present.

Hidden: Specifies whether or not to render a field (2) in views or forms.

ID: GUID for the field (2).

Id: A writer SHOULD NOT include this attribute. A reader MUST ignore this attribute.

IMEMode: If specified, indicates a value for the ime-mode attribute to be applied to an <input> tag when reading the field (2).

Indexed: Specifies that a server can optimize for queries that filter on this field (2).

ImnHeader: This attribute is a marker. A reader MUST only check for the existence of the attribute. A writer MUST either not include the attribute or set its value to TRUE.

IsolateStyles: For a Text field (2) 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 it will not interfere with the rendering of the surrounding page. A reader MUST ignore this attribute in other circumstances.

JoinColName: Specifies the physical storage location in the list referred to by the List attribute to compare with the local value of a Lookup field (2).

JoinRowOrdinal: A writer SHOULD NOT include this attribute<5>.

JoinType: Specifies how to treat items that have no corresponding matching item in the list indicated by the List attribute. A reader MUST ignore this attribute except for Lookup fields.

JumpTo: Specifies the Name of the next field (2) in a survey list when the field has a specified value. A reader MUST ignore this attribute for Boolean fields.

JumpToFillinChoice:  Specifies the Name of the next field (2) in a survey list when a value other than those listed in the CHOICES child element is selected. A reader MUST ignore this attribute except for Choice fields and MultiChoice fields for which the FillInChoice attribute is TRUE.

JumpToNo: Specifies the Name of the next field (2) in a survey list for a Boolean field whose value is FALSE.

JumpToYes: Specifies the Name of the next field (2) in a survey list for a Boolean field whose value is TRUE.

LCID: The LCID used to render Number fields, Currency fields, and DateTime fields. When not present, specifies that the default LCID for the user is to be used. A reader MUST ignore this attribute for other types of fields.

List: Specifies the foreign list for a Lookup field (2). A writer MUST include this attribute for Lookup fields. A reader MUST ignore this attribute for other kinds of fields.

Max: Specifies the maximum value for a Number field (2). A reader MUST ignore this attribute for other kinds of fields.

MaxLength: Specifies the maximum number of characters allowed in a Text field (2).

maxLength: The reader MUST ignore this attribute.

Min: Specifies the minimum value for a Number field (2). A reader MUST ignore this attribute for other kinds of fields.

Mult: In fields whose field (2) internal type is Integer, Number, or Calculated, a reader MUST interpret this as a floating point number by which the value is multiplied at render time. In this context, a reader MUST interpret the default to be 1.0.

In the context of a Lookup field (2), a reader MUST interpret the presence of this attribute as an indication that the field is a multi-value lookup, and the absence of which is an indication that the field is a single-value lookup. In this context, a writer MUST either omit the attribute or set the value to TRUE. In other contexts, a reader MUST ignore the attribute and the writer SHOULD NOT include the attribute.

Name: String that identifies the field (2) within its list.

NegativeFormat: A writer SHOULD NOT include this attribute <6>. A reader MUST ignore this attribute.

node: A writer SHOULD use the Node attribute rather than this attribute. A reader MUST ignore this attribute when the Node attribute is present. Otherwise, a reader MUST use this attribute for the same purpose as it would use the Node attribute.

Node: When present, specifies an XPath to be used to read or write the value of the field (2) into an XML document.

NoEditFormBreak: For fields where RichText is TRUE or where the Type is Choice or MultiChoice, a reader MUST ignore this attribute. For other fields, if TRUE, this attribute specifies that the following field (2) is to be rendered on the same line as this field.

NumLines: The number of lines to render when accepting input for a Note field (2). A reader MUST ignore this attribute for other fields.

Percentage: When specified on a Number field (2) or a Calculated field that evaluates to a number, specifies that the field is rendered as a percentage (100 times its value and with a trailing "%" character). A reader MUST ignore this attribute for other fields.

PIAttribute: A reader MUST ignore this attribute if either the Node or node attribute is present, or if both the PrimaryPIAttribute and PrimaryPITarget attributes are present, or if the PITarget attribute is not present. Otherwise, the reader MUST treat this attribute as it would the PrimaryPIAttribute attribute.

PIN: A writer SHOULD only include this when the Format attribute is set to Telephone. A reader MUST ignore this unless the Format is set to Telephone.

PITarget: A reader MUST ignore this attribute if either the Node or node attribute is present, if both the PrimaryPIAttribute and PrimaryPITarget attributes are present, or if the PIAttribute attribute is not present.

Otherwise, the reader MUST treat this attribute as it would the PrimaryPITarget attribute.

PrependId: Specifies whether the edit form for a Lookup field (2) for which the Multi attribute is TRUE will present choices sorted by ID rather than by the ShowField. A reader MUST ignore this attribute in other circumstances.

Presence: Specifies whether a User field (2) will be decorated with instant messaging presence information. A reader MUST ignore this attribute for fields that are not user fields.

PreviousName: Indicates the value of the Name attribute of the field (2) in an earlier revision of the containing list's schema.

PrimaryKey: A reader MUST ignore this attribute.

PrimaryPIAttribute: When present, specifies an attribute for an XML processing instruction to be used to read or write the value of the field (2) into an XML document.

PrimaryPITarget: When present, specifies an XML processing instruction to be used to read or write the value of the field (2) into an XML document.

ReadOnly: Determines whether or not the user is allowed to change the field (2) through the user interface. If TRUE, only programmatic changes are allowed.

ReadOnlyEnforced: Determines whether or not the user is allowed to change the field (2) by any means. If TRUE, the field (2) can only be changed by the system.

RenderXMLUsingPattern: Specifies whether or not a Computed field (2) is rendered using its DisplayPattern child element even when rendering for the object model or SOAP interfaces. A reader MUST ignore this attribute except for Computed fields.

Required: Specifies whether or not forms presented to accept data for the list item permits blank values for the field (2).

RestrictedMode: For Notes fields for which the RichText attribute is TRUE, this attribute specifies whether or not the field (2) permits cut, copy, paste, and insert image commands. For other kinds of fields, the reader MUST ignore this attribute.

ResultType: If the Type attribute specifies that the internal type of the field (2) is Calculated, a reader SHOULD use this attribute as in place of the internal type of the field to render results. A reader MUST ignore this attribute if the internal type of the field (2) is not Calculated.

ResyncOnChange: Specifies whether or not the field's value changes value on form submission.

RichText: Specifies whether or not a Note field (2) contains formatted text; the exact text formatting is subject to the value of the RichTextMode attribute. A reader MUST ignore this attribute except for Note fields.

RichTextMode: Specifies the serialization of formatted text.

RowOrdinal: The comments for the ColName attribute apply to this attribute as well.

RowOrdinal2: The comments for the ColName attribute apply to this attribute as well.

Sealed: Specifies how the server allows the field (2) to be changed. If TRUE, the server MUST prevent changes to the field (2) except for the DisplayName, Description, Hidden, and Indexed attributes and the ParserRefs child element.

SeparateLine: Determines whether the field (2) is displayed on a different row for views that support this feature.

SetAs: A writer SHOULD NOT include this attribute. A reader MUST ignore this attribute.

ShowAddressBookButton: Determines whether or not a field's edit control includes a facility for entering users from an address book. A reader MUST ignore this attribute except when rendering the field (2) in the context of a form that supports this functionality.

ShowField: Specifies the field (2) in the foreign list that supplies the value of a Lookup field. A reader MUST ignore this attribute unless the field (2) is a Lookup field. If the Type attribute is User, the default value for this attribute is InmName. If the Type is WorkflowStatus, the default value for this attribute is Status1. Otherwise, the default value is Title.

ShowInDisplayForm: Whether the field (2) is shown or hidden in a form designed to show the item in a read-only fashion. If TRUE, the field (2) will be shown in the form for the item. If FALSE, the field (2) will not be shown in the form. If not specified, an implementation-specific algorithm is used to determine if the field will be shown.

ShowInEditForm: When FALSE, indicates that the field (2) is not included in the form that is used to modify an item. When TRUE, indicates that the field's inclusion in such a form depends on implementation.

ShowInFileDialog: The reader MUST ignore this attribute.

ShowInFileDlg: Similar to ShowInEditForm, except that it applies to a form designed to collect information about a document from within the context of an application.

ShowInEditDlg: Similar to ShowInEditForm, except that it applies to a form designed to collect information about an item that is being modified.

ShowInListSettings: Similar to ShowInEditForm, except that it applies to the field's inclusion in the user interface that is presented to list schema editors.

ShowInNewForm: Similar to ShowInEditForm, except that it applies to the field's inclusion in a form designed to collect information about an item that is being created.

ShowInVersionHistory: Similar to ShowInEditForm, except that it applies to the field's inclusion in a form designed to display a read-only rendition of a historical version of an item.

ShowInViewForms: Similar to ShowInEditForm, except that it applies to the field's inclusion in the user interface that is presented to view authors.

Sortable: When FALSE, specifies that query results are not allowed to be ordered with respect to this field (2).

SourceID: URI suitable for use in an XML namespace in cases where the list schema is transformed to an XSD.

StaticName: Local part of an XML element name that is unique within the namespace given by the SourceID attribute.

StorageTZ: For DateTime fields, specifies the time zone in which the field (2) is stored. If TRUE, UTC is indicated; otherwise the site's local time zone is indicated. The reader MUST ignore this attribute unless the field's type is DateTime.

StripWS: The reader MUST ignore this attribute.

SuppressNameDisplay: When specified on a User field (2), the user's name is not displayed but all other rendering information is displayed.

TextOnly: The reader MUST ignore this attribute.

Title: When present on a CrossProjectLink field (2) whose DisplayImage attribute is set and whose Format attribute specifies EventList, this attribute specifies a textual alternative to the image. When not present but the other conditions are specified, the reader MUST infer a default value from the DisplayName attribute. When these conditions are not met, the reader MUST ignore the attribute.

TitleField: Specifies that the file is suitable to use for a title of the item.

Type: Specifies the rendering properties and internal type of the field (2).

UniqueId: The reader MUST ignore this attribute.

UnlimitedLengthInDocumentLibrary: On a Note field (2) or on a Lookup field for which the Mult attribute is TRUE, this attribute specifies that the length of the content is not limited.

URLEncode: The reader MUST ignore this attribute.

URLEncodeAsURL: The reader MUST ignore this attribute.

UserSelectionMode: When present on a User field (2), PeopleOnly indicates that only principals that are users are selected, and PeopleAndGroups indicates that both principals that are users and those that are groups can be selected.

UserSelectionScope: When present on a User field (2), specifies the group to which the selected user or users belong.

Version: Current version of the field (2). The server MUST increment the value by 1 each time the field definition is changed.  The client MUST ignore this attribute.

Viewable: Specifies whether or not the field (2) was added to the default view of the list when it was added to the schema of the list. The reader SHOULD ignore this attribute.

WebId: For Lookup fields, this attribute specifies the identifier of the site that contains the list referenced by the List attribute.

Width: This attribute has the same semantics as the Height attribute except that it refers to the width of the image rather than the height.

WikiLinking: When TRUE on a Note field (2) whose RichText attribute is TRUE, additional processing is done to facilitate entering hyperlinks within the content of the field. In other circumstances, the reader MUST ignore this attribute.

WorkflowStatusURL: The reader MUST ignore this attribute.

XName: String that is used to correlate the field (2) in an external schema.