Click or drag to resize

TypedMapper Methods

The TypedMapper type exposes the following members.

Methods
  NameDescription
Public methodStatic memberAttachT
Creates a new instance of the specified class (a TypedMapper dervirative) and attaches it to the mapper. You should generally not call Close on the returned TypedMapper object as that TypedMapper is a wrapper on the provided IMapper object to which it is attached (no new mapper is instantiated). Calling Close on the TypedMapper would in turn call Close on the attached mapper.
Public methodAttachExisting
Attaches an existing mapper to this class. You should generally not call Close on the this TypedMapper object as the TypedMapper will be a wrapper on the provided IMapper object to which it is attached (no new mapper is instantiated). Calling Close on the TypedMapper would in turn call Close on the attached mapper.
Public methodCloneT
Creates a cloned mapper and positions it to before the first row.
Public methodCloneAndIterateT
Creates a cloned mapper based on this object and positions it to before the first row, then iterates over each row calling the provided function. Note: If you include MapperCloneFlags you almost always want to include the 'FilterOnSelectedKeys' flag along with your provided flags. If you don't include this flag and you are operating on a mapper that is datasheet based, the checkbox selections will be ignored.
Public methodClose
Closes the underlying mapper
Public methodDelete
Calls IMapper.Delete on the underlying mapper.
Public methodDispose
Close the underlying mapper if it was created during construction of the object
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetKeyDisplayCollection
Returns the KeyDisplayText collection with the field captions
Public methodGetKeyDisplayCollection(KeyDisplayCollectionFlags)
Returns the KeyDisplayText collection
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue(String)
Get the value for the specified field. If the field is not found then an error is raised.
Public methodGetValue(String, Object, FindBehaviour)
Get the value for the specified field. The behaviour when the field is not found is dictated by the behaviour parameter.
Public methodIterateT
Iterates over this typedmapper calling the provided function
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveNew
Moves to a new record in the mapper.
Public methodMoveNext
Moves to the next record in the mapper.
Protected methodNullableValue
Returns null if the provided object is null or a blank/empty string, else the object itself. The purpose is to allow blank/empty strings to be treated as null for casting to a nullable type.
Public methodOnUnload
This event is fired just prior to the TypedMapper being unloaded. Derived implementations can override this event to perform appropriate cleanup.
Protected methodOpen(IAppContext, String, String, Flavors, MapperAttrs)
Creates a new mapper and moves to the first record.
Public methodStatic memberOpenT(IAppContext, String)
Public methodStatic memberOpenT(IAppContext, String, Flavors)
Public methodStatic memberOpenT(IAppContext, String, Flavors, MapperAttrs)
Protected methodOpenNew(IAppContext, String, Flavors, MapperAttrs)
Creates a new mapper and moves to a new record.
Public methodStatic memberOpenNewT(IAppContext)
Creates a new mapper and moves to a new record. The mapper is in the New state, ready to accept values. No query is performed. You must explicitly call Close or Dispose on the object after this call.
Public methodStatic memberOpenNewT(IAppContext, Flavors)
Creates a new mapper and moves to a new record. The mapper is in the New state, ready to accept values. No query is performed. You must explicitly call Close or Dispose on the object after this call.
Public methodStatic memberOpenNewT(IAppContext, Flavors, MapperAttrs)
Creates a new mapper and moves to a new record. The mapper is in the New state, ready to accept values. No query is performed. You must explicitly call Close or Dispose on the object after this call.
Protected methodOpenReader(IAppContext, String, String, Flavors, MapperAttrs, String, MapperLoadFlags)
Creates a new mapper for reading or iteration. You must call MoveNext to move to the first record.
Public methodStatic memberOpenReaderT(IAppContext, String)
Creates a new mapper for reading or iteration. You must call MoveNext to move to the first record.
Public methodStatic memberOpenReaderT(IAppContext, String, Flavors)
Public methodStatic memberOpenReaderT(IAppContext, String, Flavors, MapperAttrs)
Public methodStatic memberOpenReaderT(IAppContext, String, Flavors, MapperAttrs, String)
Public methodStatic memberOpenReaderT(IAppContext, String, Flavors, MapperAttrs, String, MapperLoadFlags)
Public methodStatic memberOpenReaderT(IAppContext, String, Flavors, MapperAttrs, String, MapperLoadFlags, Int32)
Public methodRequery
Calls Requery on the underlying mapper and position to the first record.
Public methodRequery(MapperFilter)
Sets the supplied filter and Requeries the underlying mapper and position to the first record.
Public methodSave
Calls IMapper.Save on the underlying mapper
Public methodSend(String, String)
Simple way to send a message using this mapper and a template. The mapper sets up the message, the relationships, and creates the template data appropriate from the current row before sending.
Public methodSend(String, String, NameValueCollection)
Simple way to send a message using this mapper and a template. The mapper sets up the message, the relationships, and creates the template data appropriate from the current row before sending.
Public methodSend(String, String, NameValueCollection, MessageRelationships)
Simple way to send a message using this mapper and a template. The mapper sets up the message, the relationships, and creates the template data appropriate from the current row before sending.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Public Extension MethodGetPageElement
Gets the PageElementInfo for the TypedMapper, if available. Note that this is simply a wrapper around the GetPageElement command.
(Defined by MapperUtils.)
Public Extension MethodIsPageElement
Determines if the TypedMapper is being rendered for the specified MOP and Name of the PageElementInfo. This method is safe to use even if the mapper is null, has no MOP, and/or has no PageElementInfo associated.
(Defined by MapperUtils.)
Top
See Also