Persistate API documentation
BaseDataType Structure
NamespacesPersistateBaseDataType

[This is preliminary documentation and is subject to change.]

This is a multi value struct generated from the base data type data class in the Persistate definition file.
Declaration Syntax
C#
public struct BaseDataType : IMultiValue
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
BaseDataType(Int32)
Creates a new BaseDataType from an integer value.

BaseDataType_
This is the value for base data type_.

Binary
This is the value for binary.

BinarySet
These BaseDataTypes represent all binary types

Boolean
This is the value for boolean.

Byte
This is the value for byte.

CanHold(Int64)
Determines if variables with this base data type can hold the supplied long value.

CanHold(Double)
Determines if variables with this base data type can hold the supplied floating point value.

CoercedText
This is the value for coerced text.

Colour
This is the value for colour.

Combinable
This is the value for combinable.

CurrencyAmount
This is the value for currency amount.

Datetime
This is the value for datetime.

Decimal
This is the value for decimal.

DefaultFormatString()()()()
Returns a default format string for the data type, or an empty string if the base data type does not take a format string.

DoubleFloat
This is the value for double float.

Empty
This is the default BaseDataType value.

Enumerated
This is the value for enumerated.

EnumeratedSet
These BaseDataTypes represent all enumerated types

Equals(Object)
Performs an equality comparison with another object.
(Overrides ValueType.Equals(Object).)
ExplicitNarrowingExplicitExplicitExplicit(BaseDataType to String)
Explicit conversion from BaseDataType to string.

Finalize()()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
FixedSet
These BaseDataTypes represent all fixed point types

Float
This is the value for float.

FloatingSet
These BaseDataTypes represent all floating point types

Font
This is the value for font.

GetHashCode()()()()
Creates a hash code for the BaseDataType.
(Overrides ValueType.GetHashCode()()()().)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
Image
This is the value for image.

ImplicitWideningImplicitImplicitImplicit(BaseDataType to Int32)
Implicit conversion from BaseDataType to int.

ImplicitWideningImplicitImplicitImplicit(Int32 to BaseDataType)
Implicit conversion from int to BaseDataType.

ImplicitWideningImplicitImplicitImplicit(String to BaseDataType)
Implicit conversion from string to BaseDataType.

Integer
This is the value for integer.

IntegralSet
These BaseDataTypes represent all integral types

IsBinary()()()()
Checks if the BaseDataType represents any kind of Binary value.

IsCombinable
Indicates whether BaseDataType values can be combined.

IsDatetime()()()()
Checks if the BaseDataType represents any kind of DateTime value.

IsEnumerated()()()()
Checks if given BaseDataType represents any kind of enumerated value.

IsFixed()()()()
Checks if the BaseDataType represents any kind of fixed point decimal numeric value. This includes currency values.

IsFloating()()()()
Checks if the BaseDataType represents any kind of floating point numeric value.

IsIntegral()()()()
Checks if the BaseDataType represents any kind of integer numeric value.

IsLong()()()()
Checks if given BaseDataType represents any kind of 'Long' value - in other words a variable length value with a very large upper size limit.

IsNone()()()()
Checks if the given BaseDataType has the value None.

IsNumeric()()()()
Checks if the BaseDataType represents any kind of numeric value.

IsText()()()()
Checks if the BaseDataType represents any kind of text value.

IsVariable()()()()
Checks if the BaseDataType represents any kind of variable length value which is not 'long'.

LongBinary
This is the value for long binary.

LongInteger
This is the value for long integer.

LongSet
These BaseDataTypes represent all long types

LongText
This is the value for long text.

MaxValue()()()()
Returns the maximum value for this base data type.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MinValue()()()()
Returns the minimum value for this base data type.

NumericSet
These BaseDataTypes represent all numeric types

ordinal
Contains the value of the BaseDataType.

Ordinal
Gets the integer ordinal value of this BaseDataType.

Parse(String)
Parses a string containing a textual representation of an BaseDataType.

ParseInstance(String)
Returns an object corresponding to the supplied text value parsed as this base data type.

Reference
This is the value for reference.

ShortInteger
This is the value for short integer.

sourcePairs
This array contains one source pair for each BaseDataType value.

SourcePairs
Gets the array of ISourcePairs holding ordinal and text values.

TakesLength()()()()
Checks if data class definitions using this type can take a length clause

TakesLengthSet
These BaseDataTypes represent all types which take a length parameter

TakesPrecision()()()()
Checks if data class definitions using this type can take a precision and scale clause

Text
This is the value for text.

TextSet
These BaseDataTypes represent all textual types

TopValue
This is the value for the top value.

ToString()()()()
Creates a textual representation of the BaseDataType.
(Overrides ValueType.ToString()()()().)
TypeFor(String)
Parses the given string as a literal value and returns the appropriate base data type.

VariableSet
These BaseDataTypes represent all variable length types which are not long

Remarks

The values taken by this struct values represent the various types of datum in the Persistate scheme, one of which is BaseDataType itself. This multi-value is Combinable, which means that values can be combined using the OR operator.

Each DataClass that you define in a Persistate application is associated with a particular BaseDataType. In addition, there is a DataClass associated to each of the BaseDataTypes themselves. These latter have the same names as the values here, have default properties, such as length, precision and scale, and can be used to define Members in Persistate ObjectClasses.

Assembly: Persistate (Module: Persistate) Version: 0.6.1.20 (0.6.1.20)