Member Junction
    Preparing search index...

    Interface RelatedFormRoleCandidate

    interface RelatedFormRoleCandidate {
        Configuration?: string | IEntityRelationshipConfiguration;
        DisplayComponentID?: string;
        DisplayInForm: boolean;
        DisplayLocation?: "After Field Tabs" | "Before Field Tabs";
        ID: string;
        InboundRelationshipCount?: number;
        JoinView?: string;
        RelatedEntity: string;
        RelatedEntityID: string;
        RelatedEntityJoinField: string;
        RelatedEntitySchemaName: string;
        RelatedRecordCollection?: string;
        Sequence?: number;
        Type?: string;
    }
    Index

    Properties

    Configuration? DisplayComponentID? DisplayInForm DisplayLocation? ID InboundRelationshipCount? JoinView? RelatedEntity RelatedEntityID RelatedEntityJoinField RelatedEntitySchemaName RelatedRecordCollection? Sequence? Type?

    Properties

    Configuration?: string | IEntityRelationshipConfiguration

    The relationship's configuration bag, either raw JSON or already parsed. EntityRelationshipInfo.Configuration parses lazily and hands back IEntityRelationshipConfiguration, while callers reading straight from a row still supply the raw string — so both are accepted, matching what ReadRelationshipInclusion, ReadRelationshipSortKey and ReadRelationshipJoinFields already take.

    DisplayComponentID?: string
    DisplayInForm: boolean
    DisplayLocation?: "After Field Tabs" | "Before Field Tabs"
    ID: string
    InboundRelationshipCount?: number

    How many EntityRelationships across metadata point at this related entity. Runtime-only — the ranker uses it as graph in-degree.

    JoinView?: string
    RelatedEntity: string
    RelatedEntityID: string
    RelatedEntityJoinField: string
    RelatedEntitySchemaName: string
    RelatedRecordCollection?: string
    Sequence?: number
    Type?: string

    Settings

    Member Visibility

    On This Page

    Properties