ArxColumnSet

Definition

Namespace

ARX.SDK.Services

Package

ARX.SDK

public class ArxColumnSet

Constructor

• ArxColumnSet()

  No columns yet: add them with AddColumn or AddColumns. A read with no columns returns every column (unlike Dynamics XRM, where an empty ColumnSet reads only the id).

• ArxColumnSet(params string[] columns)

  These columns: new ArxColumnSet("name", "email").

  Parameter	Type	Description
  columns	params string[]	The column names, in the order to read them.

Properties

• static ArxColumnSet All { get; }

  Every column of the row source: a new set each time, so changing one never changes another. It replaces the constructor that took a bool, removed in 1.0.0-rc.1: its false read every column too, unlike XRM's ColumnSet(false). An empty new ArxColumnSet() also reads every column; to read only the id, name it: new ArxColumnSet("id").

• bool AllColumns { get; set; }

  True to read every column of the row source.

• List<string> Columns { get; }

  The columns to read, by name.

Methods

• void AddColumn(string column)

  Adds an attribute to read.

  Parameter	Type	Description
  column	string	The column to read.

• void AddColumns(params string[] columns)

  Adds attributes to read.

  Parameter	Type	Description
  columns	params string[]	The columns to read.

Usage

Columns = new ArxColumnSet("id", "name")

Retrieve without a catalog, scenario 2

Used in:

• Remember resolved tables, or preload themCreate
• Retrieve one recordRetrieve
• Choose the columns to readRetrieve
• Find a record by id, key or columnsRetrieve
• Retrieve without a catalogRetrieve
• Read your own writes in an ARX transactionRetrieve
• Read a viewRetrieveMultiple
• Lookups and display namesRetrieveMultiple
• Views in depth: computed criteria, links both ways, declared ids and lookups, column boundariesRetrieveMultiple
• Retrieve on a preloaded schema: lookups found, column types, Strict, saved JSONRetrieveMultiple
• Place an order through a procedureExecute
• Execute in an ARX transactionExecute
• Execute on a preloaded, Strict schema: routines aren't covered, tables areExecute