FieldRef Element (Query)
Applies to: SharePoint Foundation 2010
Represents a reference to a field within a query.
<FieldRef
Alias = "Text"
Ascending = "TRUE" | "FALSE"
CreateURL = "Text"
DisplayName = "Text"
Explicit = "TRUE" | "FALSE" Format = "Text"
ID = "Text"
Key = "Text" List = "Text"
Name = "Text"
RefType = "Text"
ShowField = "Text"
TextOnly = "TRUE" | "FALSE"
Type = "Text">
</FieldRef>
Attributes
Attribute |
Description |
---|---|
Alias |
Optional Text. |
Ascending |
Optional Boolean. This specifies the sort order on a FieldRef element that is defined in a view. The default value is TRUE. |
CreateURL |
Optional Text. Specifies the URL for the .aspx file that is used to create a Meeting Workspace site. |
DisplayName |
Optional Text. This attribute provides the display name of the field that is referenced. |
Explicit |
Optional Boolean. This attribute is only supported within the ViewFields element. TRUE if the field is explicitly declared in the view definition and is not returned in a Fields enumeration inside a view. |
Format |
Optional Text. |
ID |
Optional Text. Specifies the GUID that identifies the field. |
Key |
Optional Text. If set to Primary, specifies that the field is the primary key for its table and thus uniquely identifies each record in the table. |
List |
Optional Text. Specifies the parent foreign list when the FieldRef element is a child of an Eq element in Join element. The value is an alias for the list that is defined by the ListAlias attribute of the Join element. |
Name |
Optional Text. This attribute provides the internal name of the field that is referenced. |
RefType |
Optional Text. Specifies the type of reference for a field in an events list. |
ShowField |
Optional Text. The ShowField attribute can be set to the field name to display. 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. |
TextOnly |
Optional Boolean. Specifies that the field contains only text values. |
Type |
Optional Text. Specifies the function that is applied to a totals column or a calculated column. Possible values include the following:
The values for the Type attribute are not case-sensitive. |
Child Elements
None |
Parent Elements
BeginsWith, Contains, DateRangesOverlap, Eq, FieldRefs, Geq, GroupBy, Gt, In, Includes, IsNotNull, IsNull, Leq, Lt, Neq, NotIncludes, OrderBy |
Occurrences
Minimum: 0 Maximum: 1 (Unbounded within OrderBy) |
Example
The following example queries for cases where the Expires field is either null or contains a value greater than or equal to the current date.
<Query>
<Where>
<Or>
<IsNull>
<FieldRef Name="Expires" />
</IsNull>
<Geq>
<FieldRef Name="Expires" />
<Value Type="DateTime">
<Today />
</Value>
</Geq>
</Or>
</Where>
<OrderBy>
<FieldRef Name="Modified" Ascending="FALSE" />
</OrderBy>
</Query>
The next example from the Schema.xml file for contacts lists specifies fields to display in the toolbar.
<ViewFields>
<FieldRef Name="LinkTitleNoMenu"></FieldRef>
<FieldRef Name="FirstName"></FieldRef>
<FieldRef Name="WorkPhone"></FieldRef>
<FieldRef Name="Email"></FieldRef>
</ViewFields>