MapperDatasheet Methods

Adds a field to the Fields collection

Used by mapper itself to add mapper commands so that we can tell if a newly added command was added by the mapper or externally.

Add removeable mapper filters to the Filters menu.

Applies or removes the specified user filter command if that command exists and is suitable for the specified MOP.

Apply the MapperDatasheet persistent context.

Apply the MapperDatasheet persistent context.

Called when the MapperExecCmd.ApplyViewState command is invoked.

Bind the mapper's fields to the controls in the specified control collection. Controls are bound by IField.ControlName which by default is the same as IField.Key.

Binds the mapper to the current .Net Page.

Binds the mapper to the current .Net Page.

Binds the mapper to the current .Net Page.

Build a javasript expression for the row calculation for the specified field.

Build the filter for the operational data query.

Build the FROM clause for the operational data query.

Builds a representation of the physical table(s) underlying a mapper including the SQL for each table required to execute the specified operation.

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.

Determine if UI should allow record delete's for this mapper.

Determine if mapper supports user drilldown to detail record.

Determines whether or not the datasheet can support editing.

Determine if UI should allow record editing for this mapper via the EditInList mechanism.

Does this field support filtering (in this mapper)?

Determines if datasheet left-side column freezing is supported.

Determines if datasheet header row freezing is supported.

Is Grouping allowed for the entire datasheet.

Determines wether the datasheet can support editing via the ImmediateSave mechanism.

Determine if pinning items is supported.

Does this mapper support user column resizing?

Does this field support user column resizing?

Determine if mapper supports record selection (i.e. checkbox row selectors).

Does this mapper support user sorting?

Get the Css Class for this row.

Clear all forms user user-specified filtering.

Clear the datasheet preferences for the current user for a single MOP or all MOPs. The primary purpose of this method is to consolidate code that allows the user to clear their datasheet filtering/sorting/grouping preferences when these preferences result in a list page being "stuck" with an invalid or timeout-producing query.

Clear the user's sort and filter preference for this page.

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

Creates a new control implementing the IBndLkup interface. Currently the determination of which control to use is based on whether or not the application is Bootstrap based.

Creates a new field object.

Gets the current grouping sort clause. Typically this is a field key name optionally followed by " DESC" when descending sort is in use.

A change to the underlying data has occurred and the mapper should requery accordingly. Currently this provides a mechanism to tell the datasheet not to use its posted-back operational data and to requery instead. Note that MapperAfterLayout is the earliest event for which this has effect in the current datasheet life-cycle.

Gets the default grouping.

Get any DefaultSort and preprocess appropriately (e.g. apply picklists).

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.

Delete the file, if any, associated with each field in this row in the mapper where the field so indicates.

Generate a list of dependency-ordered fields. The dependencies are based on property references to other fields.

Generate a link URL to this mapper's corresponding detail for the row (specified by the provided RowKey). By default the detail MOP is module!detail where module is the module of the datasheet's page and detail is the literal page "detail". This can be overridden by setting the page's "DetailTarget" property to the detail target MOP.

Determine the grouping group and group caption for this item.

Close the database connection(s)

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.

Used to apply a full-text search (FTS) within the currently filtered list.

Throws an error if saving this record would create a duplicate record as defined by those fields marked with the DupeCheck attribute.

Encode the provided text for use in the DataGrid. The encoding may vary by target browser. Example of this include handling truncated text in Safari, and handling hidden columns in browsers other than IE and Firefox.

Encode the provided text for use in the DataGrid. The encoding may vary by target browser. Example of this include handling truncated text in Safari, and handling hidden columns in browsers other than IE and Firefox.

Determines whether the specified Object is equal to the current Object.

Excape expressions to prevent possible field reference evaluation. Currently the only escaping performed is to replace all square brackets ("[") with double square brackets. Resolving an escaped expression will yield the original expression.

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.

Extracts the data types from the query and set on the fields.

Get the behaviour options for the specified field.

Obtain the appropriate label text for the specified field.

Get the filter list options for the specified field.

Devlog a field-specific entry using caller as source with mapper and field identified.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

Fire a mapper extension event with empty parameters.

Fire a mapper extension event with the specified event arguments.

See IMapper.FireEvent.

Fire a field extension event for the specified field.

Fire a field extension event for the specified field.

Fire the ExtensionEvents.RowCurrent event. Immediately prior to the event being fired the mapper's DeleteLocked property is cleared and RowLocked property is cleared as are those of all the mapper's fields.

Set a ForceFilter for the specified MOP. A ForcedFilter set as a preference just before navigation will cause a one-time application of the specified filter to the page being navigated to. The filter will be set as a selected user filter on the page. Note that the ForceFilter will expire if not used promptly.

Generate javascript for DataRow object used to access mapper values, by field key, on the client.

Gets the mapper's "caption" property per flags. The result is exposed via IMapper.Exec(MapperExecCmds.Caption). Note that GetCaption() is normally overridden by derived classes to render a caption appropriate for the type of mapper.

Get the specified localized text for this page. Obtaining the text is a cascading process from most specific to least specific always using the IDS as the id: 1) Look for the text item in the PageInfo's TextItems collection, 2) If not found, look for the text item in the mapper's TextItems collection, 3) If not found, look for the item in the locale resource file, 4) If not found, use the provided defaultText. Note that the text is resolved for field expressions. To avoid this or for additional options, use, GetCascadedText(String, String, CascadedTextOptions).

Get the specified localized text for this page. Obtaining the text is a cascading process from most specific to least specific always using the IDS as the id: 1) Look for the text item in the PageInfo's TextItems collection, 2) If not found, look for the text item in the mapper's TextItems collection, 3) If not found, look for the item in the locale resource file, 4) If not found, use the provided defaultText.

Get the specified localized text for this page. Obtaining the text is a cascading process from most specific to least specific always using the IDS as the id: 1) Look for the text item in the field's TextItems collection (if provided), 2) If not found, look for the text item in the PageInfo's TextItems collection, 3) If not found, look for the text item in the mapper's TextItems collection, 4) If not found, look for the item in the application's TextItems collection, 5) If not found, look for the item in the locale resource file, 6) If not found, use the provided defaultText.

Gets the mapper's "description" property and resolves it for field expressions. The result is exposed via IMapper.Exec(MapperExecCmds.Description).

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).

Get the specified localized text for the specified field. Obtaining the text is a three step process: 1) Look for the text item specified by name in the field's TextItems collection, 2) if not found, look for the item specified by ids in the locale resource file, 3) if not found, use the provided defaultText.

Returns the complete filter.

Returns the FireAndForgetCountHelper object for a given fire and forget sql request

Get the mapper's FROM clause (without the word FROM).

Serves as a hash function for a particular type.

Gets a standard icon or its application-specific override if one is specified.

Get an array of keys using the current filter.

Build a URL to the current mapper per the specified flags.

Get the specified localized text for this mapper. Obtaining the text is a three step process: 1) Look for the text item specified by name in the mapper's TextItems collection, 2) if not found, look for the item specified by ids in the locale resource file, 3) if not found, use the provided defaultText.

Get a list of the required fields whose values are null or blank.

Determine the number of data records with the current filter and without any TopN qualifier.

Returns the RecordCount (an int) for the mapper, but catches any error that is thrown. Use this exec command instead of RecordCount if you want to guarantee that no error is thrown.

Get the collection of fields in the mapper that comprise the row keys.

Gets an ArrayList of the currently selected keys. The base implementation is appropriate for detail use where there is just a single current row. For other uses this method should be overridden.

Get the sort clause. The base class implementation is overridden here to support grouping.

Gets the Type of the current instance.

Get the grouper field associated with the specified field. Note that this is overridden in MapperDatasheet because grouping there is more limited.

Determine whether or not the datasheet should have a Filter-by-Form (FBF) row.

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.

Insert a new record. Called by IMapper.Save when mapper is positioned on a new row.

The internal _recordCount property should always be set using this method to ensure that associated information, specifically _recordCountError, is also set properly.

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 specified CellTypeAttribute is set. Since a CellTypeAttribute is valid only for a particular CellType (since the bits are reused for other CellTypes), we must check both the CellType and CellTypeAttributes.

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

Determines whether or not the specified field is grouped inside another field when presented in a datasheet.

Determine if column grouping is specified for this list. Note that even if grouping is specified, it is possible that we will end up NOT adding a grouper header due to various factors (e.g. user having hidden all grouped cells).

Determines whether or not this field should be included in the HTML if it is hidden. There are two aspects to this: 1) Data sensitivity - If the data is marked sensitive and it is not visible in the UI then DO NOT put it in the HTML! 2) Performance - We don't want stuff we don't need in the HTML. However, we often need hidden data in the HTML for use in some client-side script.

Determines whether or not the mapper is currently performing the specified HttpRequest action, else false. This is generally based on the event target (__EVENTTARGET) from the request. Note that most of these actions really apply only to the MapperDatasheet.

Determines if the specified id is that of a datasheet selector checkbox, and, if so, extracts the RowKey value from it.

Determines whether this field is a "sensitive" field. A sensitive field should not have its value discoverable in the HTML source if the field value is not supposed to be visible to the user.

Determine if the specified field that should be hidden due to user preferences.

Is the specified field visible?

Layout the current mapper controls.

Determines whether or not a layout is required on a post-back.

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.

Register debug info about field counts including total, omitted, hidden.

Devlog an exception using caller as source with mapper identified.

Devlog an entry using caller as source with mapper identified.

Creates a shallow copy of the current Object.

Merge two sort clauses. SQL-Server will error if the same column is used more than once in an ORDER BY clause. If that happens on a saved sort there's no way to recover without clearing user preferences. This method will throw out any repeated columns.

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.

Called when the user invokes an ItemCommand on the DataGrid.

Called when user pages through the mapper.

Handle a sort command from the UI (user clicked on sortable column header).

Wrap the MapperKernel::OpenOperationalData so we can do some Datasheet-specific pre- and post-query processing. The query can be invoked in several ways, directly from the datasheet in FillTable(), or from MapperKernel::Requery and this provides a single entry point for all cases. Note that we let the base class do the actual query.

Modify a resolved expression per the specified expression attributes.

Gets the ObjectPermissions for the mapper.

Persist the column width for the specified mapper and field.

Refresh appropriate picklists used by fields in this mapper. Currently that means picklists marked "volatile". And, for each picklist flushed, remove it from session cache (if cached) and have CloneParent flush as well.

Populate the mapper's fields' default values with values from a parent mapper, if any.

Populate field values from the mapper's internal EOFReader.

Populate the mapper's field values from their defaults.

Populate the mapper's field values by extracting values from the page's controls per their field bindings.

Populate the mapper's field values from the mapper's data source.

Called immediately following OpenOperationalData() to allow a derived type to perform post-requery handling. The MapperKernel::PostRequery() has an empty implementation. Note that if PreRequery() is called, PostRequery() is called even if PreRequery() returns false such that OpenOperationalData() was not called.

Called immediately before OpenOperationalData() to allow a derived type to perform pre-requery handling. The MapperKernel::PreRequery() has an empty implementation.

Query for mapper aggregate data.

Query the operational data for the mapper.

Register DevLog information for logging if and only if the mapper's operational query fails.

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

Resolve an expression containing field references.

Resolve an expression possibly having field references. Since while filling the datasheet the fields data has already passed through the fields and left them positioned beyond the last row of interest, we need to get the field values from the DataTable.

Resolve an expression possibly having field references. Since while filling the datasheet the fields data has already passed through the fields and left them positioned beyond the last row of interest, we need to get the field values from the DataTable.

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

The datasheet is presenting data rows posted back in the grid from the previous request and NOT from requerying. Try to reconstitute certain information that we would otherwise have created during the requery.

Called when a user clicks a row button.

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.

Requeries the current row following a save in order to pick up any trigger or calculated column changes.

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.

Apply the specified SavedFilter to the mapper including any full-text search value.

Apply a SavedFilter to the mapper including any full-text search value.

Save off a NetQuarry.SavedFilter for this mapper capturing its current filter and sort state.

Save off a NetQuarry.SavedFilter for this mapper capturing its current filter and sort state.

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.

Generate a clientID for a row selector checkbox.

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.

Set the mapper's data source.

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 the RowCalc() javascript for the mapper.

Set up this mapper from a PageInfo object.

Set the mapper's field values from the current post.

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

Extract the parts of a SortSpec from a SortSpec.

Get the field key from a SortSpec.

Determine if sticky (persistent) FBF is supported.

Returns a String that represents the current Object.

Try to get one or more RowKeys specifically identified in mapper event args.

Update the current record. Called by IMapper.Save when mapper is positioned on an existing row.

Determine whether or not this mapper supports user filtering. Currently the datsheet supports this using Filter-by-Form (FBF) mechanism.

Retrieves the list of mapper field keys in the order they should be presented to the user in a datasheet taking any user-customized column order into account. Unless a explicit ColOrder property is specified on the mapper, first are fields marked with FreezeColumn the are fields explicitly ordered by the user and then all other fields. Note that field visibility is NOT taken into account and, in fact, the list may include keys for which no field is defined. The list is guaranteed to not include duplicates.

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.