> ## Documentation Index
> Fetch the complete documentation index at: https://si.easyaf.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# FormDefinition

> Immutable snapshot of a form elicitation. Produced by [IFormElicitationSource.ToDefinition](/mcpessentials/api-reference/CloudNimble/McpEssentials/Core/Tasks/Elicitations/...

## Definition

**Assembly:** CloudNimble.McpEssentials.Core.dll

**Namespace:** CloudNimble.McpEssentials.Core.Tasks.Elicitations

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormDefinition
```

## Summary

Immutable snapshot of a form elicitation. Produced by
[IFormElicitationSource.ToDefinition](https://si.easyaf.dev/api-reference/CloudNimble/McpEssentials/Core/Tasks/Elicitations/IFormElicitationSource#todefinition) and by `String)`.

## Constructors

###  .ctor

Initializes a form snapshot.

#### Syntax

```csharp theme={"dark"}
public FormDefinition(string message, System.Collections.Generic.IReadOnlyList<CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormFieldDefinition> fields, string name = null)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `message` | `string` | The prompt presented with the form. |
| `fields` | `System.Collections.Generic.IReadOnlyList<CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormFieldDefinition>` | The fields in insertion order. |
| `name` | `string?` | Optional keyed-DI name when this snapshot is a published copy of a named form. |

#### Exceptions

| Exception | Description |
| - | - |
| `ArgumentException` | Thrown when *message* is empty. |
| `ArgumentNullException` | Thrown when *fields* is [`null`](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null). |

### &#x20;.ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### &#x20;Fields

Gets the fields in insertion order.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.IReadOnlyList<CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormFieldDefinition> Fields { get; }
```

#### Property Value

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

### &#x20;Message

Gets the prompt presented with the form.

#### Syntax

```csharp theme={"dark"}
public string Message { get; }
```

#### Property Value

Type: `string`

### &#x20;Name

Gets the optional keyed-DI name, or [`null`](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when the island is anonymous.

#### Syntax

```csharp theme={"dark"}
public string Name { get; }
```

#### Property Value

Type: `string?`

## Methods

### &#x20;Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### &#x20;GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### &#x20;MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### &#x20;ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.