FieldRef Element

  • Article

The FieldRef element is used in computed fields to refer to the constituent fields and in views to define what fields are present.

Syntax

<FieldRef
  Ascending = "TRUE" | "FALSE"
  CreateURL = "Text"
  DisplayName = "Text"
  Explicit = "TRUE" | "FALSE"
  Key = "Text"
  Name = "Text"
  RefType = "Text"
  TextOnly = "TRUE" | "FALSE"
  Type = "Text">
</FieldRef>

Attributes

Name Description
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.
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.
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. The following table describes possible values.

ValueDescription
AVGAverage value. Applies to DateTimeNumber, Integer, and Currency field types.
COUNTNumber of items. Applies to all field types that allow aggregation.
MAXMaximumn value. Applies to DateTimeNumber, Integer, and Currency field types.
MINMinimum value. Applies to DateTimeNumber, Integer, and Currency field types.
SUMSum of values. Applies to Number, Integer, and Currency field types.
STDEVStandard deviation. Applies to Number, Integer, and Currency field types.
VARVariance. Applies to Number, Integer, and Currency field types.

The values for the Type attribute are not case-sensitive.
Value Description
AVG Average value. Applies to DateTimeNumber, Integer, and Currency field types.
COUNT Number of items. Applies to all field types that allow aggregation.
MAX Maximumn 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.

Element Relationships

Parent Elements
FieldRefs, OrderBy, ViewFields

Example

The following example queries for cases where the Expires field either is 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 following 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>