A Sandcastle Documented Class Library

# Relationship Class

Class that contains the relationship information between two data structures.
Inheritance Hierarchy
System
Object
Dundas.BI.Data.Metadata
DescriptorBase
Dundas.BI.Data.Relationships
Relationship

Namespace: Dundas.BI.Data.Relationships
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public class Relationship : DescriptorBase

    Public Class Relationship
    	Inherits DescriptorBase

    public ref class Relationship : public DescriptorBase

    type Relationship =
        class
            inherit DescriptorBase
        end

The Relationship type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| Relationship | Initializes a new instance of the Relationship class, as a user-defined relationship.

Top
Properties

| Name | Description
--- | --- | ---
| Category | Gets the relationship category.
| Description | Gets or sets the object description. (Inherited from DescriptorBase.)
| Id | Gets the object ID. (Inherited from DescriptorBase.)
| Keys | Gets the relationship keys.
| Name | Gets or sets the object name. (Inherited from DescriptorBase.)
| ReferencedStructureId | Gets the referenced structure ID.
| StructureId | Gets the structure ID.

Top
Methods

| Name | Description
--- | --- | ---
| AddRelationshipKey(RelationshipKey) | Adds a new relationship key to the current instance. The operation is allowed only if the relationship category is not Native. The category is subsequently changed automatically UserDefined.
| AddRelationshipKey(String, String) | Adds a new relationship key to the current instance. The operation is allowed only if the relationship category is not Native. The category is subsequently changed automatically UserDefined.
| ClearRelationshipKeys | Clears the relationship keys from the current instance. The operation is allowed only if the relationship category is not Native.
| GetKeyElementNames | Gets the key element names for the specified structure ID.
| RemoveRelationshipKey | Removes the specified key from the current instance. The operation is allowed only if the relationship category is not Native.
| ToString | Returns a string that represents the current object. (Inherited from DescriptorBase.)

Top
See Also

#### Reference

Dundas.BI.Data.Relationships Namespace