Skip to main content

Definition

Assembly: CloudNimble.McpEssentials.Core.dll Namespace: CloudNimble.McpEssentials.Core.Tasks.Elicitations Inheritance: System.Object

Syntax

Summary

Immutable snapshot of one form field. Produced by IFormElicitationSource.ToDefinition and by String).

Constructors

.ctor

Initializes a field with name and type. Remaining facets are set with object initializers.

Syntax

Parameters

Exceptions

.ctor Inherited

Inherited from object

Syntax

Properties

DefaultBool

Gets the default boolean value, or null when unset.

Syntax

Property Value

Type: System.Nullable<bool>?

DefaultNumber

Gets the default numeric value, or null when unset.

Syntax

Property Value

Type: System.Nullable<double>?

DefaultString

Gets the default string or single-select value, or null when unset.

Syntax

Property Value

Type: string?

DefaultStrings

Gets the default multi-select values, or null when unset.

Syntax

Property Value

Type: System.Collections.Generic.IReadOnlyList<string>?

Description

Gets the description shown with the field.

Syntax

Property Value

Type: string?

Format

Gets the string format: email, uri, date, or date-time.

Syntax

Property Value

Type: string?

Maximum

Gets the maximum numeric value.

Syntax

Property Value

Type: System.Nullable<double>?

MaxItems

Gets the maximum number of selected items on a multi-select field.

Syntax

Property Value

Type: System.Nullable<int>?

MaxLength

Gets the maximum string length.

Syntax

Property Value

Type: System.Nullable<int>?

Minimum

Gets the minimum numeric value.

Syntax

Property Value

Type: System.Nullable<double>?

MinItems

Gets the minimum number of selected items on a multi-select field.

Syntax

Property Value

Type: System.Nullable<int>?

MinLength

Gets the minimum string length.

Syntax

Property Value

Type: System.Nullable<int>?

Name

Gets the camelCase wire name.

Syntax

Property Value

Type: string

Options

Gets the allowed values for enum and multi fields.

Syntax

Property Value

Type: System.Collections.Generic.IReadOnlyList<CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormOptionDefinition>

Required

Gets whether the field is listed in required.

Syntax

Property Value

Type: bool

Title

Gets the display title.

Syntax

Property Value

Type: string?

Type

Gets the primitive kind.

Syntax

Property Value

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormFieldType?

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?