IMapper Methods

Binds the mapper to the current .Net Page.

Binds the mapper to the current .Net Page.

Binds the mapper to the current .Net Page.

Initiate a bulk delete using the mapper and fire its corresponding extension event. The object controlling the bulk operation typically makes this call before performing the delete operations in a loop using the same mapper instance. The bulkContext will be provided in the BulkContext parameter for all mapper events performed during the bulk operation. If a null bulkContext object is provided, the method will instantiate one for you. If you want a custom bulkContext, you should derive from the base EventBulkContext object and provide an instance of your derived class. If BulkDeleteBegin is called, you should call BulkDeleteEnd when the operation completes. Note that the MapperBulkBeforeDelete event is fired from within this method.

Complete a bulk delete operation that was initiated with a call to BulkDeleteBegin(EventBulkContext). This method will delete the mapper's internal bulk context object set by that call. This method should be called if, and only if, BulkDeleteBegin was called. Note that the MapperBulkAfterDelete event is fired from within this method.

Initiate a bulk insert using the mapper and fire its corresponding extension event. The object controlling the bulk operation typically makes this call before performing the insert operations in a loop using the same mapper instance. The bulkContext will be provided in the BulkContext parameter for all mapper events performed during the bulk operation. If a null bulkContext object is provided, the method will instantiate one for you. If you want a custom bulkContext, you should derive from the base EventBulkContext object and provide an instance of your derived class. If BulkInsertBegin is called, you should call BulkInsertEnd when the operation completes.

Complete a bulk insert operation that was initiated with a call to BulkInsertBegin(EventBulkContext). This method will delete the mapper's internal bulk context object set by that call. This method should be called if, and only if, BulkInsertBegin was called.

Initiate a bulk update using the mapper and fire its corresponding extension event. The object controlling the bulk operation typically makes this call before performing the update operations in a loop using the same mapper instance. The bulkContext will be provided in the BulkContext parameter for all mapper events performed during the bulk operation. If a null bulkContext object is provided, the method will instantiate one for you. If you want a custom bulkContext, you should derive from the base EventBulkContext object and provide an instance of your derived class. If BulkUpdateBegin is called, you should call BulkUpdateEnd when the operation completes.

Complete a bulk update operation that was initiated with a call to BulkUpdateBegin(EventBulkContext). This method will delete the mapper's internal bulk context object set by that call. This method should be called if, and only if, BulkUpdateBegin was called.

Create a clone of the mapper. Unless otherwise specified by modifier flags, the clone will be requeried using the same filters and sort as the original mapper.

Create a clone of the mapper. Unless otherwise specified by modifier flags, the clone will be requeried using the same filters and sort as the original mapper.

Closes all internal resources

Delete the current record. Note that, following the delete and all associated mapper events, the mapper will perform a MoveNext to position to the next record in the filter. Because of this, when deleting multiple records you should not perform a MoveNext except on those rows you do not intend to delete. See also DeleteAll to delete all records in the filter.

Delete all records in the current filter. DeleteAll is a bulk operation and as such will fire the MapperBulkBeforeDelete and MapperBulkAfterDelete events. Typically at the start of DeleteAll processing an EventBulkContext is established, however, you may establish a custom bulk context by calling BulkDeleteBegin(EventBulkContext) immediately prior to calling DeleteAll.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Execute the specified command. Typically commandName is the ID of one of the MapperCommand items added to the mapper's Commands collection. To invoke a command by its Command, pass a 1 in the flags parameter.

The Exec method provide extended functionality for mappers. See MapperExecCmds for the enumerated list of commands.

The Exec method provide extended functionality for mappers. See MapperExecCmds for the enumerated list of commands.

FireEvent is called by the owner to fire an event to the mapper's extensions.

Gets a semi-colon separated list of fields to render for this mapper based on various PageElementInfo properties including FieldList, FieldListMobile, and GroupList, or on a value set programmatically via SetFieldList(String, SetFieldListOpts). Also handles the HiddenFields property when HiddenFields is specified. Note that the possibililty of HiddenFields complicates construction of a field list and typically requires calling this method first to get a possible list of explicitly shown fields (where no such list means to show all fields normally visible in the mapper) then calling the method again to get a possible list of explicitly hidden fields and combining the results (including handling the case where fields are explicitly hidden, but not explicitly shown).

Handle a specific HTTP request.

Determines if the mapper has the specified ObjectPermissions for the current user. If the object has no assigned permisions, the return value is true.

This method initializes the mapper.

This method initializes the mapper.

This method initializes the mapper.

Determines if a particular attribute (or any of a set of attributes) is set. Note that this is a shorthand for the expression (0 != (mapper.Attributes & attributes)) (C#) or (0 <> (mapper.Attributes Or attributes)) (VB).

Determines if the mapper is currently configured for the specified MapperCapabilities.

Loads the mapper's meta-data from the RepositoryIDatabase. Use Load(MapperLoadFlags) to load the mapper with specific load options.

Loads the mapper's meta-data from the RepositoryIDatabase.

Sets up the mapper's meta-data per the table's schema. If so specified the mapper will use the table's data.

Move to the Beginning Of File (BOF). That is, position the cursor just prior to the first record in the mapper. Note that this will throw an InvalidMapperMovement error if the mapper is positioned on or beyond the first record and is not BiDirectional. Use MoveFirst to position directly to the first data row.

Move to the first record in the mapper. Note that this will throw an InvalidMapperMovement error if the mapper is positioned beyond the first record and is not BiDirectional. Use MoveBOF to position just prior to the first data row.

You should not call MoveFirst prior to calling MoveNext to loop through records in a mapper as this will result in the first record being skipped (unless of course you want to skip the first record). Immediately following a Requery(RequeryHints) the mapper will already be positioned BOF and you can simply loop by calling MoveNext. If you are using a BiDirectional mapper and need to perform subsequent MoveNext loops, call MoveBOF to position just prior to the first data row before starting each subsequent MoveNext.

Move to the last record in the mapper.

Move to a new record.

Move to a new record.

Move to the next record in the mapper.

You should not call MoveFirst prior to calling MoveNext to loop through records in a mapper as this will result in the first record being skipped (unless of course you want to skip the first record). Immediately following a Requery(RequeryHints) the mapper will already be positioned BOF and you can simply loop by calling MoveNext. If you are using a BiDirectional mapper and need to perform subsequent MoveNext loops, call MoveBOF to position just prior to the first data row before starting each subsequent MoveNext.

Move to the previous record in the mapper. Note that this will throw an InvalidMapperMovement error if the mapper is not BiDirectional.

Move to a record relative to the current record. Note that this will throw an InvalidMapperMovement error if movement is negative and the mapper is not BiDirectional.

Move to a record relative to the current record. Note that this will throw an InvalidMapperMovement error if movement is negative and the mapper is not BiDirectional.

Move to the specified row number (1-based). Note that RowCurrent events are NOT fired and data is NOT moved through the mapper's Fields during the move. In general you should use this method to position the mapper to the record immeditately PRIOR to the first record of interest and then use MoveNext to iterate through one or more records of interest.

Move to the row corresponding to the specified RowKey.

Gets the ObjectPermissions for the mapper.

Opens the operational data reader, or fills the internal DataTable, for the mapper.

Resolve a !Sort() expression into its constituent parts.

Generate a digest of the field values in the mapper for the current row.

RowKeyFilter is used to build a filter unique for a RowKey obtained from the RowKey property.

Save the current changes. If no fields are Dirty, no save is performed. You can use the Save(MapperSaveOptions) to override certain standard Save behaviour, the standard behaviour is typically recommended. See Save(MapperSaveOptions) for some additional information about mapper saves.

Save the current changes allowing for specific MapperSaveOptions options. If no fields are Dirty, no save is performed. Saves are typically performed using the Save method with default mapper Save behaviour.

SelectedKeys is used to obtain a list of the RowKeys for the rows currently selected in the mapper. In a detail this is the current row. In a datasheet this is the set of selected rows.

SelectedKeys is used to obtain a list of the RowKeys for the rows currently selected in the mapper. In a detail this is the current row. In a datasheet this is the set of selected rows. If an EAPEventArgs object is provided from a particular mapper event that can specify one or more RowKeys, e.g. EAPCommandEventArgs.RowKey and one or more RowKeys are specified in that object, then the RowKey(s) from the event will be returned.

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.

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.

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.

Sets the semi-colon separated list of fields to render for this mapper. Setting this value programmatically overrides any meta-data specified list. See GetFieldList(GetFieldListOpts).

Generates a signature string for the mapper as currently filtered and sorted.

Gets the PageElementInfo for the IMapper, if available. Note that this is simply a wrapper around the GetPageElement command.

Determines if the IMapper 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.

Resolve the specified field expression using ExpressionResolve mapper command. See ExpressionParser for more information about field expressions. Use ExpressionEscape to escape apparent field references in a string. Note that although, for historical reasons, the ExpressionResolve command will throw an error if the expression contains an unresolvable field or other syntax error, this method DOES NOT throw by default because it adds the DoNotThrow flag UNLESS the ThrowOnAnomaly flag is set.