Class FieldMetaData

The methods and properties in the FieldMetaData class manage fields.

Inheritance

object

MetaData

FieldMetaData

Inherited Members

MetaData.Name

MetaData.Description

MetaData.DataType

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: WRQ.Verastream.HostIntegrator

Assembly: WRQ.Verastream.HostIntegrator.dll

Syntax

[Serializable]
public class FieldMetaData : MetaData

Properties

IsKey

Gets the key flag for a field.

Declaration

public virtual bool IsKey { get; }

Property Value

Type	Description
bool	boolean true if the field is a key

Remarks

This property indicates if this recordset field is designated as a Key value. A key value is unique for the associated field in the recordset--no other records will have the same value for that field.

IsReadable

Gets the readable flag for a field.

Declaration

public virtual bool IsReadable { get; }

Property Value

Type	Description
bool	Gets the readable flag for a field.

Remarks

Gets the readable flag for a field, which indicates whether the field can be read by a client.

IsWriteable

Gets the writeable flag for a field.

Declaration

public virtual bool IsWriteable { get; }

Property Value

Type	Description
bool	Gets the writeable flag for a field.

Remarks

Gets the writeable flag for a field, which indicates whether Host Integrator allows this field to have data written to it.

Length

Gets the length of a field.

Declaration

public virtual int Length { get; }

Property Value

Type	Description
int	Gets the length of a field.

Remarks

If the returned value is -1, the length of the field is variable.

TerminalAttributesEnabled

Gets the terminal attributes enabled flag for a field.

Declaration

public virtual bool TerminalAttributesEnabled { get; }

Property Value

Type	Description
bool	Gets the terminal attributes enabled flag for a field.

Remarks

Gets the flag for the field that specifies whether terminal attributes are enabled. The terminal attributes enabled flag indicates whether Host Integrator can return the terminal attributes of the field. Terminal attributes specify various properties the text can have, including color, whether the text is blinking, and whether the text is displayed in reverse video.