Class DataExchange

Namespace

PolarStudio

Assembly

PolarStudio.dll

This class is the main object for creating and importing data exchange files.

public class DataExchange : PolarWeakEventListener

Inheritance

object

DataExchange

Implements

PolarWeakEventListener

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

AutoImportAllExplicitlyExportedRecords

Gets/sets to automatcally import all explicitly exported records in the import file.

public bool AutoImportAllExplicitlyExportedRecords

Field Value

bool

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 bool ImportPolicy_AutomaticRecords_ImportMissing

Field Value

bool

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 bool ImportPolicy_AutomaticRecords_UpdateExisting

Field Value

bool

ImportPolicy_RequiredRecords_UpdateExisting

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

public bool ImportPolicy_RequiredRecords_UpdateExisting

Field Value

bool

ImportPolicy_SelectedRecords_UpdateExisting

Gets/sets to import records explicitly selected by the user.

public bool ImportPolicy_SelectedRecords_UpdateExisting

Field Value

bool

Properties

DataExchangeTables

Returns the tables that apply for data exchange.

public DataExchangeTables DataExchangeTables { get; }

Property Value

DataExchangeTables

DataExchangeVersion

The version of the data exchange.

public double DataExchangeVersion { get; }

Property Value

double

Engine

Returns the Engine.

public BudaEngine Engine { get; set; }

Property Value

BudaEngine

FormMode

The form mode. Used internally.

public string FormMode { get; set; }

Property Value

string

ImportRootNode

Returns the root xml node of the import file.

public XmlNode ImportRootNode { get; }

Property Value

XmlNode

SelectedTable

The current selected table. Used internally.

public string SelectedTable { get; set; }

Property Value

string

Methods

CreateHTML(Context)

Creates the html to show the user interface. Used internally.

public string CreateHTML(Context pContext)

Parameters

pContext Context

The context.

Returns

string

The html

DoAction(Context, string)

Performs an action. Used internally.

public string DoAction(Context pContext, string pAction)

Parameters

pContext Context

The context.

pAction string

The action.

Returns

string

A message.

DownloadData(Context)

Will download the data in the web session of the given context.

public string DownloadData(Context pContext)

Parameters

pContext Context

The context.

Returns

string

An error message if applicable.

GetBlob(Context)

Helper to download data.

public string GetBlob(Context pContext)

Parameters

pContext Context

Returns

string

GetExportXML(Context, ref string)

This method gets the xml with the export data.

public string GetExportXML(Context pContext, ref string pErrorMessage)

Parameters

pContext Context

The context.

pErrorMessage string

This by-ref parameter is set to an error message if applicable.

Returns

string

A unicode string containing the xml.

IncludeTableInDataExchange(Context, repTable)

This method returns True if the specified table is to be included in the data exchange.

public bool IncludeTableInDataExchange(Context pContext, repTable pTableSettings)

Parameters

pContext Context

The context.

pTableSettings repTable

The table settings of the table to query.

Returns

bool

A boolean indicating the table is to be included.

PerformImportAndUpdates(Context, ref string)

This method performs the import and updates.

public string PerformImportAndUpdates(Context pContext, ref string pLogResult)

Parameters

pContext Context

The context.

pLogResult string

This by-ref string will contain the full log of the result of the import and updates.

Returns

string

An error message if applicable.

SetImportFile(Context, string, string)

This method sets the import file (both the name and the data).

public string SetImportFile(Context pContext, string pFileName, string pFileData)

Parameters

pContext Context

The context.

pFileName string

The name of the file.

pFileData string

The xml file data as unicode string.

Returns

string

An error message if applicable.