FormDefinition Class

Object to construct an XML serialized form that defines input properties displayed to the user. After Serialize is executed the information is supplied through the return value of the Connector's IConnector.PreConnect method. Once received from the user the requested information is supplied to the Connector via the Scribe.Core.ConnectorApi.IConnector.Connect method.

Inheritance Hierarchy

System Object

Scribe.Core.ConnectorApi.ConnectionUI FormDefinition

Namespace: Scribe.Core.ConnectorApi.ConnectionUI

Assembly: Scribe.Core.ConnectorApi (in Scribe.Core.ConnectorApi.dll)

Syntax

[KnownTypeAttribute(typeof(EntryDefinition))]
public   class   FormDefinition

The FormDefinition type exposes the following members.

Constructors

	Name	Description
	FormDefinition	Initializes a new instance of the FormDefinition class

Methods

	Name	Description
	Add	This will add entry definitions to the form.
	Deserialize	Deserializes this from a string.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Serialize	Serializes this into a string.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	CompanyName	Gets or sets the Company Name. This property is required.
	CryptoKey	Gets or sets CryptoKey. This property is required.
	Entries	Gets or sets the list of the entries in the order they will be placed in the form.
	HelpUri	Gets or sets the Help URL. If supplied, this will present a help link that points to this location. The location should be an absolute Uri. This property is not required and will not display a help link if one is not supplied.

See

Scribe.Core.ConnectorApi.ConnectionUI Namespace