Click or drag to resize

DBStoredProcedureParameter Class

Class which represents a Stored procedure parameter
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.DBDriverCoreDBElementBase
    SD.LLBLGen.Pro.DBDriverCoreDBStoredProcedureParameter

Namespace:  SD.LLBLGen.Pro.DBDriverCore
Assembly:  SD.LLBLGen.Pro.DBDriverCore (in SD.LLBLGen.Pro.DBDriverCore.dll) Version: 5.4.0.0 (5.4.0)
Syntax
public class DBStoredProcedureParameter : DBElementBase, 
	ISerializableToXml, IProjectElementFieldMapTargetElement

The DBStoredProcedureParameter type exposes the following members.

Constructors
  NameDescription
Public methodDBStoredProcedureParameter
Initializes a new instance of the DBStoredProcedureParameter class.
Public methodDBStoredProcedureParameter(String, DBTypeDefinition)
Initializes a new instance of the DBStoredProcedureParameter class.
Public methodDBStoredProcedureParameter(String, DBTypeDefinition, String)
Initializes a new instance of the DBStoredProcedureParameter class.
Top
Properties
  NameDescription
Public propertyCreatedByDesigner
Gets or sets a value indicating whether this element is created by the designer from mappings (true) or that it was created from meta-data retrieved from the database (false, default).
(Overrides DBElementBaseCreatedByDesigner.)
Public propertyCustomProperties
Gets the Custom properties (name - value pairs) read from the schema.
(Inherited from DBElementBase.)
Public propertyDbTypeAsString
Gets the DbType as string.
Public propertyDefaultValue
The default value for this field. It is represented in a string, since it's only used in the code generation process. Is only valid if HasDefaultValue returns true.
Protected propertyDeserializing
Gets or sets a value indicating whether this instance is deserializing.
(Inherited from DBElementBase.)
Public propertyDirection
Specifies the direction of the parameter
Public propertyErrorLog
Gets the complete ErrorLog for this object.
(Inherited from DBElementBase.)
Public propertyFieldName
Literal name of the field.
Public propertyFullName
Gets the full name which is of the format: Parent's FullName.FieldName
(Overrides DBElementBaseFullName.)
Public propertyFullNameForXml
Gets the full name for XML. This is a name which has the format schemaname:elementname or schemaname:elementname:fieldname. Used for references.
(Inherited from DBElementBase.)
Public propertyFullNameForXmlWithCatalog
Gets the full name for XML. This is a name which has the format catalogname:schemaname:elementname or catalogname:schemaname:elementname:fieldname. Used for references.
(Inherited from DBElementBase.)
Public propertyHasDefaultValue
Flag which signals if this field has a default value. If true, DefaultValue should return the default value for this field.
Public propertyIsComputed
Flag which signals if this field's value is retrieved using a function stored with the field in the database.
Public propertyIsForeignKey
Flag which signals if this field has a foreign key (FK) constraint. By design, fields can have only one foreign key constraint, since more than one is semantically wrong.
Public propertyIsIdentity
Flag which signals if this field is an autonumber/identity field.
Public propertyIsNullable
Flag which signals if this field can contain NULL.
Public propertyIsPrimaryKey
Flag which signals if this field is part of the primary key (PK) of the IDBTable referenced by Parent.
Public propertyIsResultsetParameter
Flag to signal if this parameter is in fact a resultset parameter, i.e. a REF CURSOR type of parameter.
Public propertyIsRowGUID
Flag which signals if this field is a RowGUID field. Microsoft Specific.
Public propertyIsTimeStamp
Flag which signals if this field is a timestamp field.
Public propertyLength
Gets the length of the type of the target field.
Public propertyMarkedForDeletion
Gets or sets a value indicating whether this element is marked for deletion.
(Inherited from DBElementBase.)
Public propertyNETTypeAsString
Gets the .NET type as string.
Public propertyOrdinalPosition
The ordinal position of this instance of IDBParameter in the stored procedure referenced by ParentStoredProcedure. OrdinalPosition is 1-based, which means the first parameter has OrdinalPosition 1. OrdinalPosition 0 is reserved for the return value of the stored procedure.
Public propertyParameterName
Literal name of the parameter.
Public propertyParent
Reference to the IProjectElementMapTargetElement instance which reflects the table this IEntityFieldMapTargetElement instance belongs to.
Public propertyParentStoredProcedure
Reference to the DBStoredProcedure instance which reflects the table this DBStoredProcedureParameter instance belongs to.
Public propertyPrecision
Gets the precision of the type of the target field.
Public propertyScale
Gets the scale of the type of the target field.
Public propertyTypeDefinition
DBTypeDefinition instance representing the type of this parameter.
Protected propertyTypeOfDBElement
Gets the type of DB element in the form of a ContainedElementType value.
(Overrides DBElementBaseTypeOfDBElement.)
Public propertyUDTName
Gets the name of the UDT the db type is based on. If not applicable, an empty string is returned.
Top
Methods
  NameDescription
Protected methodDeserializeAdditionalAttributes
Deserializes attributes of this element's base class from the reader.
(Inherited from DBElementBase.)
Public methodDeserializeFromReader
Deserializes from reader.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from DBElementBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleContainedListChangedTChangeType
Handles the contained list changed.
(Inherited from DBElementBase.)
Public methodLogError
Logs an error in the ErrorLog structure of this object.
(Inherited from DBElementBase.)
Public methodLogWarning
Logs the description as a warning.
(Inherited from DBElementBase.)
Protected methodMarkElementAsChangedTChangeType
Marks the element as changed.
(Inherited from DBElementBase.)
Public methodMarkElementAsRemoved
Marks the element as removed, which raises the ElementRemoved event.
(Inherited from DBElementBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnContainedElementAdded
Called when this object received an event of type ContainedElementAdded
(Inherited from DBElementBase.)
Protected methodOnContainedElementChanged
Called when this object received an event of type ContainedElementChanged
(Inherited from DBElementBase.)
Protected methodOnContainedElementRemoved
Called when this object received an event of type ContainedElementRemoved
(Inherited from DBElementBase.)
Protected methodOnPropertyChanged
Raises the PropertyChanged event.
(Inherited from DBElementBase.)
Protected methodPerformAdditionalContainedElementChangedWork
Performs the additional contained element changed work. Override if additional work has to be done after the OnContainedElementChanged method has run.
(Inherited from DBElementBase.)
Public methodResetErrorLog
Resets the Error Log for this object to an empty list.
(Inherited from DBElementBase.)
Protected methodSerializeAdditionalAttributes
Serializes the additional attributes.
(Inherited from DBElementBase.)
Public methodSerializeToWriter
Serializes the data in this class to the serializer passed in
Public methodToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Top
Events
  NameDescription
Public eventContainedElementAdded
Raised when an element was added to a collection (indirectly) contained in this element
(Inherited from DBElementBase.)
Public eventContainedElementChanged
Raised when an element contained in this element was changed.
(Inherited from DBElementBase.)
Public eventContainedElementRemoved
Raised when an element was removed from a collection (indirectly) contained in this element
(Inherited from DBElementBase.)
Public eventHasBeenChanged
Raised when the implementing element has been changed
(Inherited from DBElementBase.)
Public eventHasBeenRemoved
Raised when the implementing element has been removed from its container
(Inherited from DBElementBase.)
Public eventPropertyChanged
Occurs when a property value changes. (INotifyPropertyChanged)
(Inherited from DBElementBase.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementCustomProperties
Gets the Custom properties (name - value pairs) read from the schema.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementDefaultSequence
Gets the default sequence. Only set when the database supports default sequence hints. otherwise null
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementDirection
Gets the direction of the parameter represented by this fieldmaptarget element
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementOrdinalPosition
The ordinal position of the instance of DBField in the table or view referenced by ParentTable or ParentView. (See DBTableField and DBViewField) OrdinalPosition is also called 'column identification number' and is the order in the fieldlist of the table or view. OrdinalPosition is 1-based, which means the first field has OrdinalPosition 1.
Explicit interface implementationPrivate propertyIProjectElementFieldMapTargetElementTypeDefinition
DBTypeDefinition instance representing the type of this field.
Top
See Also