FormXml

Definition

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

Syntax

CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormXml

Summary

Closed AOT codec for the compact Form / Field / Option island. Uses XmlWriter / XmlReader. Does not use XmlSerializer, sgen, or reflection over the form type.

Remarks

Readers match LocalName only. Writers emit xmlns when xmlNamespace is supplied. DTD processing is prohibited. Comments are ignored. Processing instructions inside Form, Field, or Option are unexpected nodes.

Examples

var xml = FormXml.Serialize(form.ToDefinition());
var definition = FormXml.Parse(xml);

Methods

Parse

Reads a compact form island. Namespace prefixes are ignored.

Syntax

public static CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormDefinition Parse(string xml)

Parameters

Name	Type	Description
`xml`	`string`	The island text.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormDefinition The snapshot.

Exceptions

Exception	Description
`ArgumentException`	Thrown when xml is empty.
`InvalidOperationException`	Thrown when the island is not a valid form.
`XmlException`	Thrown when the text is not well-formed XML or contains a DTD.

Serialize

Writes a compact form island. Omits the XML declaration.

Syntax

public static string Serialize(CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormDefinition definition, string xmlNamespace = null)

Parameters

Name	Type	Description
`definition`	`CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormDefinition`	The snapshot to write.
`xmlNamespace`	`string?`	Optional namespace URI placed on `Form` as `xmlns`.
OData passes the MCP vocabulary document URI.

Returns

Type: string The island text.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when definition is `null`.

Getting Started

API Reference

Definition

Syntax

Summary

Remarks

Examples

Methods

Parse

Syntax

Parameters

Returns

Exceptions

Serialize

Syntax

Parameters

Returns

Exceptions

​Definition

​Syntax

​Summary

​Remarks

​Examples

​Methods

​ Parse

​Syntax

​Parameters

​Returns

​Exceptions

​ Serialize

​Syntax

​Parameters

​Returns

​Exceptions

Definition

Syntax

Summary

Remarks

Examples

Methods

Parse

Syntax

Parameters

Returns

Exceptions

Serialize

Syntax

Parameters

Returns

Exceptions