ColumnSet Class

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API the corresponding type is ColumnSet ComplexType.

Namespace:   Microsoft.Xrm.Sdk.Query
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

System.Object
  Microsoft.Xrm.Sdk.Query.ColumnSet

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

NameDescription
System_CAPS_pubmethodColumnSet()

Initializes a new instance of the ColumnSet class.

System_CAPS_pubmethodColumnSet(Boolean)

Initializes a new instance of the ColumnSet class setting the AllColumns property.

System_CAPS_pubmethodColumnSet(String[])

Initializes a new instance of the ColumnSet class setting the Columns property.

NameDescription
System_CAPS_pubpropertyAllColumns

Gets or sets whether to retrieve all the attributes of a record.

System_CAPS_pubpropertyColumns

Gets the collection of Strings containing the names of the attributes to be retrieved from a query.

System_CAPS_pubpropertyExtensionData

Gets or sets the structure that contains extra data.

NameDescription
System_CAPS_pubmethodAddColumn(String)

Adds the specified attribute to the column set.

System_CAPS_pubmethodAddColumns(String[])

Adds the specified attribute to the column set.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: