Class FieldReference

Represents a reference to a field within a query.

Inheritance
System.Object
FieldReference
Namespace: CamlBuilder
Assembly: PnP.Framework.dll
Syntax
public class FieldReference : object

Constructors

FieldReference()

Creates an instance of FieldReference with all it's properties set to default.

Declaration
public FieldReference()

FieldReference(String)

Creates an instance of FieldReference with the initial specified name.

Declaration
public FieldReference(string name)
Parameters
System.String name

Internal name of the field.

Properties

Alias

Field alias.

Declaration
public string Alias { get; set; }
Property Value
System.String

Ascending

This specifies the sort order on a FieldRef.

Declaration
public bool? Ascending { get; set; }
Property Value
System.Nullable<System.Boolean>

Remarks

Query defaults this to true when no value is specified.

CreateUrl

Specifies the URL for the .aspx file that is used to create a Meeting Workspace site.

Declaration
public string CreateUrl { get; set; }
Property Value
System.String

DisplayName

This attribute provides the display name of the field that is referenced.

Declaration
public string DisplayName { get; set; }
Property Value
System.String

Explicit

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.

Declaration
public bool? Explicit { get; set; }
Property Value
System.Nullable<System.Boolean>

Format

Field format.

Declaration
public string Format { get; set; }
Property Value
System.String

Id

Specifies the GUID that identifies the field.

Declaration
public string Id { get; set; }
Property Value
System.String

Key

If set to Primary, specifies that the field is the primary key for its table and thus uniquely identifies each record in the table.

Declaration
public string Key { get; set; }
Property Value
System.String

List

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

Declaration
public string List { get; set; }
Property Value
System.String

LookupId

When the field is a Lookup type, specifies that queries should look for the item by its unique item ID rather than the field value. This can be useful, for example, when multiple items have identical values in the field and you want to query for a specific item.

Declaration
public bool? LookupId { get; set; }
Property Value
System.Nullable<System.Boolean>

Remarks

Query default this to false when no value is specified

Name

This attribute provides the internal name of the field that is referenced.

Declaration
public string Name { get; set; }
Property Value
System.String

RefType

Specifies the type of reference for a field in an events list.

Declaration
public string RefType { get; set; }
Property Value
System.String

ShowField

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.

Declaration
public string ShowField { get; set; }
Property Value
System.String

Remarks

The following data types are allowed as targets of a ShowField attribute: Text, Choice, and Counter.

TextOnly

Specifies that the field contains only text values.

Declaration
public bool? TextOnly { get; set; }
Property Value
System.Nullable<System.Boolean>

Type

Specifies the function that is applied to a totals column or a calculated column.

Declaration
public FieldReferenceFunctionType? Type { get; set; }
Property Value
System.Nullable<FieldReferenceFunctionType>

Operators

Implicit(String to FieldReference)

Uses fieldName as a field reference internal name and returns a new FieldReference.

Declaration
public static implicit operator FieldReference(string fieldName)
Parameters
System.String fieldName

String to be used as FieldReference internal name.
Returns
FieldReference

Extension Methods