Class bpxField

Namespace

PolarDataInterop.Catalog

Assembly

PolarDataInterop.dll

This class contains the details of a field in the catalog.

public class bpxField

Inheritance

object

bpxField

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

Globals.IsNumericType(object)

Properties

AutoNumber

Returns True if this field is an autonumber.

public bool AutoNumber { get; }

Property Value

bool

BaseColumnName

Returns the name of the base column. Specifically for fields in views.

public string BaseColumnName { get; }

Property Value

string

BaseField

Returns the catalog-field for the base-field. Specifically for fields in views.

public bpxField BaseField { get; }

Property Value

bpxField

BaseTableName

Returns the name of the base table. Specifically for fields in views.

public string BaseTableName { get; }

Property Value

string

Catalog

Returns the catalog this field is part of.

public bpxCatalog Catalog { get; }

Property Value

bpxCatalog

DefaultValue

Returns the DefaultValue as SQL expression.

public string DefaultValue { get; }

Property Value

string

Description

Returns the description for this field in the extended properties of the database.

public string Description { get; }

Property Value

string

FieldType

Returns the type of field.

public string FieldType { get; }

Property Value

string

ForeignKey

Returns the foreign key for this field (if it is a foreign key field).

public bpxForeignKey ForeignKey { get; }

Property Value

bpxForeignKey

HasDefaultValue

Returns True if this field has a default value.

public bool HasDefaultValue { get; }

Property Value

bool

MaxLength

Returns the maximum length of text fields.

public int MaxLength { get; }

Property Value

int

Name

Returns the name.

public string Name { get; }

Property Value

string

NumericPrecision

Returns the numeric precision

public int NumericPrecision { get; }

Property Value

int

NumericScale

Returns the numeric scale

public int NumericScale { get; }

Property Value

int

Required

Returns True if this field is required.

public bool Required { get; }

Property Value

bool

Table

Returns the catalog table this field is part of.

public bpxTable Table { get; }

Property Value

bpxTable

TableName

Returns the name of the table.

public string TableName { get; }

Property Value

string

Methods

CreateFieldSQL()

Returns the SQL expression to create this field (without foreign key).

public string CreateFieldSQL()

Returns

string

A string like: CustomerName VARCHAR(100) NOT NULL

DefaultValueAsScriptExpression()

Returns a script-expression that tries to match the SQL server default value.

public string DefaultValueAsScriptExpression()

Returns

string

A script expression. If no match, the default value is returned unchanged to let the programmer make a wise decision.

ToString()

public override string ToString()

Returns

string

ToString(clsString)

Adds the string-representation for this field to the specified pResult.

public void ToString(clsString pResult)

Parameters

pResult clsString

The clsString object to add the field-string to.