FieldRef Element (Query)

Article
05/05/2014

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Represents a reference to a field within a query.

<FieldRef
  Alias = "Text"
  Ascending = "TRUE" | "FALSE"
  CreateURL = "Text"
  DisplayName = "Text"
  Explicit = "TRUE" | "FALSE"
  ID = "Text"
  Key = "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.
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.
Name	Required 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: AVG Average value. Applies to DateTimeNumber, Integer, and Currency field types. COUNT Number of items. Applies to all field types that allow aggregation. MAX Maximum value. Applies to DateTimeNumber, Integer, and Currency field types. MIN Minimum value. Applies to DateTimeNumber, Integer, and Currency field types. SUM Sum of values. Applies to Number, Integer, and Currency field types. STDEV Standard deviation. Applies to Number, Integer, and Currency field types. VAR Variance. Applies to Number, Integer, and Currency field types. The values for the Type attribute are not case-sensitive.

Child Elements

None

Parent Elements

BeginsWith, Contains, DateRangesOverlap, Eq, Geq, GroupBy, Gt, IsNotNull, IsNull, Leq, Lt, Neq, 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>