TypedMapper Methods |
The TypedMapper type exposes the following members.
Name | Description | |
---|---|---|
AttachT |
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.
| |
AttachExisting |
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.
| |
CloneT |
Creates a cloned mapper and positions it to before the first row.
| |
CloneAndIterateT |
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.
| |
Close |
Closes the underlying mapper
| |
Delete |
Calls IMapper.Delete on the underlying mapper.
| |
Dispose |
Close the underlying mapper if it was created during construction
of the object
| |
Equals | (Inherited from Object.) | |
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.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetKeyDisplayCollection |
Returns the KeyDisplayText collection with the field captions
| |
GetKeyDisplayCollection(KeyDisplayCollectionFlags) |
Returns the KeyDisplayText collection
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValue(String) |
Get the value for the specified field.
If the field is not found then an error is raised.
| |
GetValue(String, Object, FindBehaviour) |
Get the value for the specified field.
The behaviour when the field is not found is dictated by the behaviour parameter.
| |
IterateT |
Iterates over this typedmapper calling the provided function
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MoveNew |
Moves to a new record in the mapper.
| |
MoveNext |
Moves to the next record in the mapper.
| |
NullableValue |
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.
| |
OnUnload |
This event is fired just prior to the TypedMapper being unloaded.
Derived implementations can override this event to perform appropriate cleanup.
| |
Open(IAppContext, String, String, Flavors, MapperAttrs) |
Creates a new mapper and moves to the first record.
| |
OpenT(IAppContext, String) |
Creates a new mapper and moves to the first record.
This method is intended for opening a single record. You should generally use an OpenReaderT(IAppContext, String, Flavors, MapperAttrs, String, MapperLoadFlags, Int32) method for iterating through a variable number of records.
You must explicitly call Close or Dispose on the object after this call.
| |
OpenT(IAppContext, String, Flavors) |
Creates a new mapper and moves to the first record.
This method is intended for opening a single record. You should generally use an OpenReaderT(IAppContext, String, Flavors, MapperAttrs, String, MapperLoadFlags, Int32) method for iterating through a variable number of records.
You must explicitly call Close or Dispose on the object after this call.
| |
OpenT(IAppContext, String, Flavors, MapperAttrs) |
Creates a new mapper and moves to the first record.
This method is intended for opening a single record. You should generally use an OpenReaderT(IAppContext, String, Flavors, MapperAttrs, String, MapperLoadFlags, Int32) method for iterating through a variable number of records.
You must explicitly call Close or Dispose on the object after this call.
| |
OpenNew(IAppContext, String, Flavors, MapperAttrs) |
Creates a new mapper and moves to a new record.
| |
OpenNewT(IAppContext) | ||
OpenNewT(IAppContext, Flavors) | ||
OpenNewT(IAppContext, Flavors, MapperAttrs) | ||
OpenReader(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.
| |
OpenReaderT(IAppContext, String) |
Creates a new mapper for reading or iteration. You must call MoveNext to move to the first record.
| |
OpenReaderT(IAppContext, String, Flavors) | ||
OpenReaderT(IAppContext, String, Flavors, MapperAttrs) | ||
OpenReaderT(IAppContext, String, Flavors, MapperAttrs, String) | ||
OpenReaderT(IAppContext, String, Flavors, MapperAttrs, String, MapperLoadFlags) | ||
OpenReaderT(IAppContext, String, Flavors, MapperAttrs, String, MapperLoadFlags, Int32) | ||
Requery |
Calls Requery on the underlying mapper and position to the first record.
| |
Requery(MapperFilter) |
Sets the supplied filter and Requeries the underlying mapper and position to the first record.
| |
Save |
Calls IMapper.Save on the underlying mapper
| |
Send(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.
| |
Send(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.
| |
Send(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.
| |
ToString | (Inherited from Object.) |
Name | Description | |
---|---|---|
EqualValue |
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.) | |
GetPageElement |
Gets the PageElementInfo for the TypedMapper, if available.
Note that this is simply a wrapper around the GetPageElement command.
(Defined by MapperUtils.) | |
IsPageElement |
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.) |