Pair Class

Assembly: CodeEffects.Rule.Editor.dll
Namespace: CodeEffects.Rule.Editor.Client

Summary

Represents one member of an Enum: its numeric value and its display name.

Syntax

public class Pair

Constructors

  • Pair()

    Creates an empty pair.

  • Pair(string id, string name)

    Creates a pair with the specified ID and name.

    Parameters

    • id (System.String): the numeric value of the enumeration member, as a string.
    • name (System.String): the display name of the member.

Properties

  • ID

    Type: System.String

    The numeric value of the enumeration member, as a string.

  • Name

    Type: System.String

    The display name of the member.

  • AiAliases

    Type: IList<System.String>

    Other names an AI agent may know the enumeration member by. They are written to the Source XML of an Adaptive Source. The Rule Editor never shows them. The default value is null.

  • AiDescription

    Type: System.String

    What an AI agent should know about the enumeration member. The Rule Editor never shows it. The default value is null.

Methods

  • ToString()

    Returns: System.String

    Returns the pair as a JSON object with the ID and Name values. The Rule Editor uses it to send the pair to the client; you do not need to call it.

Ask on Stack Overflow - Yes, it's still active
Ask in GitHub Discussions

p102

l097 --

l102

p101

×