AVEVA Database .NET Public Interface

DbFieldFormat Members

DbFieldFormat overview

Public Instance Constructors

DbFieldFormat Constructor Initializes a new instance of the DbFieldFormat class.

Public Instance Properties

ArraySeparator String to use to separate individual array elements. Typically ', ' for a list
DbRestriction INTEGER database number to restrict elements to those from a certain database for certain special fields (e.g. owner and member types). 0 for no restriction.
DefaultAction Action to take if a value is found which does not match a specified mapping By default, this is GET_AS_STRING which will leave the value unchanged It may be set to FIXED_STRING so that any such (unmapped) string will be replaced by the DefaultString
DefaultString String with which to replace any string for which no individual mapping has been defined (with AddMapping) Only used if the DefaultAction is FIXED_STRING
ItemSeparator String to use to separate items within compound fields. Only used for special fields such as attributes and descriptions. Typically a tab or a colon
NonEmptyPrefix String to prepend to the result if and only if it is not the empty string
NonEmptySuffix String to append to the result if and only if it is not the empty string
RemoveDuplicates Whether or not duplicate array items are to be removed NB: Equality is checked AFTER any replacements and mappings
SortValues Whether or not array items are to be sorted into alphabetic order NB: Sorting is applied AFTER any replacements and mappings
UndefinedString String to substitute if no value is defined

Public Instance Methods

AddMapping Add a mapping; ie, a specification of a value which is to be replaced by another value
AddReplace Add a replacement specification. Replacements are applied first, and will replace any and all occurences of the invalue in values returned with the rvalue
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
FormatOverloaded. Return the formatted value of a field for a given attribute
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
ToString (inherited from Object) Returns a String that represents the current Object.

See Also

DbFieldFormat Class | Aveva.Pdms.Database Namespace