Class DataExchangeTable

Namespace

PolarStudio

Assembly

PolarStudio.dll

This class contains the details of a data exchange table.

public class DataExchangeTable

Inheritance

object

DataExchangeTable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Globals.IsNumericType(object)

Fields

Filter

Gets/sets the filter used for this table to limit the shown records.

public string Filter

Field Value

string

Properties

Caption

Returns the caption of the table.

public string Caption { get; }

Property Value

string

ImportPolicy_AutomaticRecords_ImportMissing

Gets/sets to import missing records that are in not-user-selectable tables and are part of related GetParent() records that are imported.

public object ImportPolicy_AutomaticRecords_ImportMissing { get; set; }

Property Value

object

ImportPolicy_AutomaticRecords_UpdateExisting

Gets/set to update records that are in not-user-selectable tables and are part of related GetParent() records that are imported.

public object ImportPolicy_AutomaticRecords_UpdateExisting { get; set; }

Property Value

object

ImportPolicy_RequiredRecords_UpdateExisting

Gets/sets to import missing records that are in not-user-selectable tables and are part of related GetParent() records that are imported.

public object ImportPolicy_RequiredRecords_UpdateExisting { get; set; }

Property Value

object

ImportPolicy_SelectedRecords_UpdateExisting

Gets/sets to update records that are required to import other records.

public object ImportPolicy_SelectedRecords_UpdateExisting { get; set; }

Property Value

object

KeyField

Returns the name of the field holding the DataExchangeKey, like 'GUID' or 'Name'

public string KeyField { get; }

Property Value

string

Name

Returns the name of the table.

public string Name { get; }

Property Value

string

RecordsCreated

Returns the number of created (inserted) records.

public int RecordsCreated { get; }

Property Value

int

RecordsUpdated

Returns the number of updated records.

public int RecordsUpdated { get; }

Property Value

int

TableSettings

Returns the settings of this table.

public repTable TableSettings { get; }

Property Value

repTable

UserSelectable

Returns True if the user can manually select records from this table for export.

public bool UserSelectable { get; }

Property Value

bool

Methods

AddSelectedRecords(string, string)

This method adds a specified list of records to the list of selected records.

public void AddSelectedRecords(string pRecordIDsList, string pFormMode)

Parameters

pRecordIDsList string

A comma separated list of recordIS

pFormMode string

The mode, use 'EXPORT' or 'IMPORT'

RemoveSelectedRecords(string, string)

This method removes a list of records from the list of selected records.

public void RemoveSelectedRecords(string pRecordIDsList, string pFormMode)

Parameters

pRecordIDsList string

A comma separated list of recordIS

pFormMode string

The mode, use 'EXPORT' or 'IMPORT'

SelectedImportRecords(bool)

Returns a comma separated list of RecordID's that are selected by the user to import.

public string SelectedImportRecords(bool pAddEnclosingCommas)

Parameters

pAddEnclosingCommas bool

If True, the list will have a comma at the beginning and end, like: ,4,5,6,

Returns

string

A comma separated list of recordID's

SelectedRecords(bool, bool)

Returns a list of the selected recordID's for export.

public string SelectedRecords(bool pAddEnclosingCommas, bool pAlsoReturnAutomaticallyAddedRecords = false)

Parameters

pAddEnclosingCommas bool

If True, the list will have a comma at the beginning and end, like: ,4,5,6,

pAlsoReturnAutomaticallyAddedRecords bool

Will include the automatically selected records (not only the explicitly selected records).

Returns

string

A comma separated list of recordID's