Item Class

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

Summary

The base class of the menu elements of an Adaptive Source. Field and Function derive from it.

Syntax

public class Item

Constructors

  • Item()

    Creates an item with Nullable and ResetsContext set to false.

Properties

  • DisplayName

    Type: System.String

    The name of the element as the Rule Editor shows it in menus and in the rule.

  • Value

    Type: System.String

    The identifier of the element. It is the name of the member on the source object that the element stands for, and it is what is stored in the rule.

  • Description

    Type: System.String

    The description of the element. The Rule Editor shows it as a tooltip for fields and methods.

  • AiAliases

    Type: IList<System.String>

    Other names an AI agent may know the element by. The Rule Repository gives them to agents that look for members; the Rule Editor never shows them. They are a label: changing them does not create a new source version. They are stored with the source and sent to the host's AI provider. The default value is null.

  • AiDescription

    Type: System.String

    What an AI agent should know about the element, when it needs more than the description. Agents read Description when this property is not set. The Rule Editor never shows it. The default value is null.

  • Nullable

    Type: System.Boolean

    Indicates whether the element accepts null values. The default value is false.

  • ResetsContext

    Type: System.Boolean

    When true, the element is the root of the context: the Rule Editor removes all conditions that follow this element if the user changes it. The default value is false.

Methods

  • ToString(bool _)

    Returns: System.String

    Returns the item as the JSON object that the Rule Editor sends to the client. The parameter is not used and is reserved for future use. The Rule Editor calls this method; you do not need to.

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

p102

l097 --

l102

p101

×