ColumnSet Class

Reference

Definition

Namespace:: Microsoft.Xrm.Sdk.Query

Assembly:: Microsoft.Xrm.Sdk.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.0.9

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies the attributes for which non-null values are returned from a query.

For the Web API the corresponding type is ColumnSet ComplexType.

public ref class ColumnSet sealed : System::Runtime::Serialization::IExtensibleDataObject

[System.Runtime.Serialization.DataContract(Name="ColumnSet", Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class ColumnSet : System.Runtime.Serialization.IExtensibleDataObject

[<System.Runtime.Serialization.DataContract(Name="ColumnSet", Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type ColumnSet = class
    interface IExtensibleDataObject

Public NotInheritable Class ColumnSet
Implements IExtensibleDataObject

Inheritance: Object
ColumnSet

Attributes: DataContractAttribute

Implements: IExtensibleDataObject

Remarks

The ColumnSet class is used with methods and messages that retrieve one or more records from the database. The query returns non-null values for the attributes that are contained in the Columns property. The attributes not included in the ColumnSet will contain null values. If the column set includes attributes that are not valid for retrieve, they will be ignored and no values will be returned for those attributes.

The primary key is always returned and contains a non-null value.

Attributes are specified by name. For more information, see SchemaName.

Constructors

ColumnSet()	Initializes a new instance of the ColumnSet class.
ColumnSet(Boolean)	Initializes a new instance of the ColumnSet class setting the AllColumns property.
ColumnSet(String[])	Initializes a new instance of the ColumnSet class setting the Columns property.

Properties

AllColumns	Gets or sets whether to retrieve all the attributes of a record.
AttributeExpressions
Columns	Gets the collection of `String`s containing the names of the attributes to be retrieved from a query.
ExtensionData	Gets or sets the structure that contains extra data.
HasLazyFileAttribute	For internal use only.
LazyFileAttributeEntityName	For internal use only.
LazyFileAttributeKey	For internal use only.
LazyFileAttributeSizeLimit	For internal use only.
LazyFileAttributeValue	For internal use only.

Methods

AddColumn(String)	Adds the specified attribute to the column set.
AddColumns(String[])	Adds the specified attribute to the column set.

Applies to