ColumnSet Class

Reference

Definition

Namespace:: Microsoft.Xrm.Sdk.Query

Assembly:: Microsoft.Xrm.Sdk.dll

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

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 columns for which non-null values are returned from a query.

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

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

Unless the query requests aggregate values, or distinct rows are requested using the QueryExpression.Distinct property, the primary key value is always returned.

Specify columns using the logical names of the columns.

For the Web API the corresponding type is ColumnSet complex type.

Constructors

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

Properties

AllColumns	Gets or sets whether to retrieve all the columns of a table or record. (Not recommended)
AttributeExpressions	Gets or sets data that describes aggregations and grouping of data.
Columns	Gets or sets the collection of strings containing the logical names of the columns 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 column to the column set.
AddColumns(String[])	Adds the specified columns to the column set.

Applies to