Class repRelationship

Namespace

PolarStudio

Assembly

PolarStudio.dll

This class contains the details of a relationship in the repository.

public class repRelationship

Inheritance

object

repRelationship

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)

Properties

AllowedStates

Returns a list of states that a record in the destination table must be in to be a valid option for this foreign key.

public repStates AllowedStates { get; }

Property Value

repStates

AskOnInsertCaptionTC

Returns the question to use when asked on an add-new in a form.

public string AskOnInsertCaptionTC { get; }

Property Value

string

AskQuestion

Returns True if a value for this field is to be asked on an add-new in a form.

public bool AskQuestion { get; }

Property Value

bool

AutoSelect

Returns True if this value is to be set automatically on ask-on-insert in an add-new if only one option is available.

public bool AutoSelect { get; }

Property Value

bool

DeletionBehaviour

Returns the action to take when a delete takes place. One of: 'RESTRICTED', 'CASCADING', 'CASCADING_FORCED', 'NULLIFY', '' (empty for no action)

public string DeletionBehaviour { get; }

Property Value

string

DependendRelationships

Returns a list of relationships that are depending on this relationship.

public repRelationshipDependencies DependendRelationships { get; }

Property Value

repRelationshipDependencies

DependsOnRelationships

Returns a list of relationships this relationship depends on.

public repRelationshipDependencies DependsOnRelationships { get; }

Property Value

repRelationshipDependencies

DestinationField

Returns the repository field of the destination (the primary key field in the destination table).

public repField DestinationField { get; }

Property Value

repField

DestinationFieldID

Returns the SysFieldID of the destination field (the primary key field in the destination table).

public int DestinationFieldID { get; }

Property Value

int

DestinationTable

Returns the destination table in the repository.

public repTable DestinationTable { get; }

Property Value

repTable

DestinationTableID

Returns the SysTableID of the destination table.

public int DestinationTableID { get; }

Property Value

int

FollowAllowed

Returns True if following this link (both up-stream and down-stream) is allowed.

public bool FollowAllowed { get; }

Property Value

bool

Identifier

Returns a custom identifier for this relationship.

public string Identifier { get; }

Property Value

string

MultiInsertAllowed

Returns True if multiple records can be selected on an add-new in a form.

public bool MultiInsertAllowed { get; }

Property Value

bool

Name

Returns the name

public string Name { get; }

Property Value

string

Notes

Returns the notes.

public string Notes { get; }

Property Value

string

ParentTableCondition

Returns a sql expression to set which values are allowed when selecting a (new) value.

public string ParentTableCondition { get; }

Property Value

string

ParentshipRelation

Returns if this relation marks a parentship.

public bool ParentshipRelation { get; }

Property Value

bool

QuickInsertParent

Returns True if a parent can be quick-inserted from an options list for the source field.

public bool QuickInsertParent { get; }

Property Value

bool

RelationshipCaptionTC

Returns a specific caption for this relationship.

public string RelationshipCaptionTC { get; }

Property Value

string

SourceField

Returns the source field in the repository (the foreign key field).

public repField SourceField { get; }

Property Value

repField

SourceFieldID

Returns the SysFieldID of the source field (the foreign key field).

public int SourceFieldID { get; }

Property Value

int

SourceTable

Returns the source table in the repository (in which the foreign key resides).

public repTable SourceTable { get; }

Property Value

repTable

SourceTableID

Returns the SysTableID of the source table (in which the foreign key resides).

public int SourceTableID { get; }

Property Value

int

SysRelationshipID

Returns the SysRelationshipID as used in the repository.

public int SysRelationshipID { get; }

Property Value

int

Methods

CaptionTC(int)

Returns the caption for the specified SysGroupID.

public string CaptionTC(int pSysGroupID)

Parameters

pSysGroupID int

The group to get the caption for.

Returns

string

The caption.

GetRelatedItemsRecordSetSource(BudaDataSet, bool)

This function returns a recordset of the Source-table for records linked to the record in the destination-table

public string GetRelatedItemsRecordSetSource(BudaDataSet pBudaDataSet, bool pShowDeletedRecords = false)

Parameters

pBudaDataSet BudaDataSet

The dataset containing the destination field.

pShowDeletedRecords bool

A boolean indicating that soft-deleted records are to be included in the list.

Returns

string

A recordset with fields ID_ and Identifer_ for the list of related items.

QuickInsertParentAllowed(int)

Returns True if QuickInsertParent is actually allowed (combines the QuickInsertParent property with the permissions on the foreign table).

public bool QuickInsertParentAllowed(int pSysGroupID)

Parameters

pSysGroupID int

The SysGroupID to get this permission for.

Returns

bool

True if allowed.