MapperList Properties |
The MapperList type exposes the following members.
Name | Description | |
---|---|---|
_cacheDataAttrs | Attributes for data caching behavior CacheDataAttrs. (Inherited from MapperKernel.) | |
_cacheID | The ID for operational data cached in the DataCache. (Inherited from MapperKernel.) | |
_cacheLife | The lifetime for operational data cached in the DataCache, in minutes. (Inherited from MapperKernel.) | |
AppendPKSort |
Determine whether or not to append a PK sort to the sort clause.
(Inherited from MapperKernel.) | |
Application |
The platform IAppContext context object. The Application is set in the Init(String, IAppContext) method.
(Inherited from MapperKernel.) | |
ApplicationAppearance |
Get the application's AppAppearance property.
(Inherited from MapperKernel.) | |
Attributes | MapperAttrs flags specifying various behaviour of the mapper.
This is normally loaded from meta-data during Load.
(Inherited from MapperKernel.) | |
BaseCacheID |
Generate the base CacheID which may be affected by CacheDataAttrs.
(Inherited from MapperKernel.) | |
BulkUpdateContext |
The bulk context of the current bulk operation, null if no bulk operation is in progress.
(Inherited from MapperKernel.) | |
CacheManagerToUse |
Gets the CacheManager to use if operational data caching is enabled.
Returns null if caching is not enabled or no CacheManager is available.
(Inherited from MapperKernel.) | |
Caption |
The localized caption for the mapper. Call Exec(MapperExecCmds, Int32, Object) with the Caption command to get a caption
that includes additional information including current paging and filtering for a live
mapper.
(Inherited from MapperKernel.) | |
ColOrderPrefName |
Gets the preference name for user column ordering.
(Inherited from MapperKernel.) | |
Commands |
Mapper commands are used to add custom MapperCommand commands to a mapper's page.
Typically commands are added to the toolbar or the More (Actions) button on the toolbar. When invoked, a
MapperCommand(IMapper, EAPCommandEventArgs) event is fired on the mapper.
You can add commands to the mapper programmatically, typically during the MapperBeforeLayout(IMapper, EAPEventArgs) event.
Commands are also added automatically from meta-data NavTarget elements with TargetType of Command
on Navigator elements configured in meta-data for use on the page, page element, or mapper.
(Inherited from MapperKernel.) | |
CssClass |
The Cascading Style Sheet class to use for the mapper.
(Inherited from MapperKernel.) | |
CurrentPage |
The 1-based current page index for the mapper. In mappers other than datasheets, the RecordsPerPage
is generally one so the CurrentPage is the same as the CurrentRecord.
(Inherited from MapperKernel.) | |
CurrentRecord |
The 1-based index of the current record in the mapper.
(Inherited from MapperKernel.) | |
Database |
The data IDatabase used by the mapper. The data database holds the mapper's operational data.
(Inherited from MapperKernel.) | |
DataSourceType |
Get the DBMSType for this mapper's data source.
Normally this is the DBMSType of
the mapper's DataDB, but if the mapper is using a live DataTable as its data
source then DBMSType.DotNet will be returned.
(Inherited from MapperKernel.) | |
DeleteLocked |
Specifies whether or not the row should be allowed to be deleted for the current row only. This property is
cleared by the mapper immediately prior to the RowCurrent event. An extension can then set the
property to true to prevent this row from being deleted.
(Inherited from MapperKernel.)The mapper also supports a DeleteLockExpression property allowing the delete lock condition to be specified in meta-data. The DeleteLockExpression is a javascript expression, typically including field references, that is evaluated with each row to initialize its DeleteLocked value. For row-level record locking, see RowLocked. | |
Dirty |
The dirty property can be read to determine if any of the mapper's fields values have been
changed since being populated from the database or original datatable. The property can be
cleared to clear the dirty flags on all the mapper's fields. If set true, the mapper's
internal dirty flag is set, but the mapper's fields are not set dirty.
(Inherited from MapperKernel.) | |
Extensions |
Gets the collection of IExtension mapper extension objects for the mapper. Extensions provide
both additional standard and custom functionality. Mapper extensions are the primary means by
which custom functionality is added to the application.
(Inherited from MapperKernel.)Generally extensions used across multiple mappers derive from the MapperExtensionKernel class whereas those that are intended for use on a single mapper derive from an application-specific generated class derived from the TypedMapperExtension template class. Extensions derived from TypedMapperExtension can only be used on the intended mapper, but provide a type-safe, easier to use implementation. These are the most common type of extension in most applications. The more primitive, but flexible MapperExtensionKernel-derived extension are typically used for non-mapper specific functionality such as in the ReadableAudit extension. Virtually all platform-provided extensions are of this type. | |
Fields |
The Fields collection of IField objects which generally corresponding to columns in the underlying table or view.
IField's are rich objects which can be configured in meta-data and manipulated programmatically.
(Inherited from MapperKernel.) | |
Filters |
The collection of MapperFilter objects used to filter the mapper queries. Filters can be specified
in meta-data and manipulated programmatically. Standard datasheet filtering is handled by the
MapperDatasheet object.
(Inherited from MapperKernel.) | |
Flavor |
Flavor is used to include or exclude certain fields based on their IncludeFlavor and ExcludeFlavor
bits. Fields that are excluded are not hidden; they are never loaded into the mapper's Fields collection.
A flavor of zero indicates that all fields with any IncludeFlavor bits set will not be loaded.
If a field is marked as both included and excluded for a particular Flavor then the exclude bit is favored.
(Inherited from MapperKernel.) | |
FTSVal |
Gets/sets the Full-Text Search value, if any.
(Inherited from MapperKernel.) | |
GroupingField |
Returns the IField currently being used to group rows in the datasheet.
(Inherited from MapperKernel.) | |
GroupPrefName |
Gets the preference name for the persisted user-specific grouping.
(Inherited from MapperKernel.) | |
HasMorePages |
Returns true if there are additional pages beyond the current page. This should be used
(possibly in conjunction with HasRecords) instead of calling RecordCount in order to manage
UI paging.
(Inherited from MapperKernel.) | |
HasRecords |
HasRecords returns true if there are one or more records in the current mapper filter, else false.
Note that using HasRecords never requires an additional database query and should therefore be
used in place of RecordCount when possible.
(Inherited from MapperKernel.) | |
HasRowKey |
Gets whether or not the mapper has a PK or UniqueKey.
Note that if mapper has no PK/UK then we only support dynamic filters not static (snapshots).
(Inherited from MapperKernel.) | |
IgnorePostback |
Indicates whether postback data is being used or ignored.
(Inherited from MapperKernel.) | |
IsCaching |
Gets whether or not operational data caching is enabled.
(Inherited from MapperKernel.) | |
IsDesignMode |
Returns true if the control is in Design mode.
(Inherited from MapperKernel.) | |
IsDetail |
Gets whether or not this mapper is a detail mapper. Currently this is true only for
MapperDetail implementations of the mapper.
(Inherited from MapperKernel.) | |
IsFiltering |
Determines if the mapper is currently being used to filter (currently based on flavor).
(Inherited from MapperKernel.) | |
IsListView |
Determines if the mapper is rendering for a list view in the UI.
(Inherited from MapperKernel.) | |
IsMobile |
Gets whether or not mapper is rendering for a mobile device.
(Inherited from MapperKernel.) | |
IsNew |
Indicates whether or not the mapper is positioned on a new row.
(Inherited from MapperKernel.) | |
IsPageMultiElement |
Gets whether or the host template a multi-element template (e.g. ConsoleTemplate) vs. a single-element template (e.g. TabbedSubformTemplate).
(Inherited from MapperKernel.) | |
Key |
Gets the key (ID) of the mapper. This is the meta-data's unique identifier for the
mapper definition.
(Inherited from MapperKernel.) | |
Mode |
Mapper mode specifies how the mapper is being used and controls the overall look and behaviour of the mapper.
(Inherited from MapperKernel.) | |
ModuleKey |
The key to the module using this mapper -- typically obtained from Module.
Note that this may be misleading on Console and Wizard pages. To obtain the module for the mapper itself
use MapperModuleKey.
(Inherited from MapperKernel.) | |
MOP |
The MOP using this mapper. A MOP is a Module-Page of the form <module>!<page>.
(Inherited from MapperKernel.) | |
OptFieldPrefName |
Gets the preference name to use for optional fields.
(Inherited from MapperKernel.) | |
OrderBy |
A SQL ORDER BY clause used as the default sort for the mapper. User sorting in a datasheet
supercedes this clause.
(Inherited from MapperKernel.) | |
Page |
The .Net Page holding this mapper.
(Inherited from MapperKernel.) | |
PageDisplayAttrs |
Get the page's PageDisplayAttrs. They should have been set in the mapper's property
collection by the page.
(Inherited from MapperKernel.) | |
PageInfo |
The PageInfo object related to this mapper. This is a reference to the session's PageInfo object.
(Inherited from MapperKernel.)Note that since this is a copy of the session's PageInfo object, you should not modify this instance of the PageInfo object. If you want to modify the PageInfo object for this mapper instance only then you should clone the PageInfo object using Clone(IAppContext) and set it back on the mapper as in the example below: Examples PageInfo info = mapper.PageInfo.Clone(cxt); info.TextItems.Add("Caption", "My Caption"); mapper.PageInfo = info; | |
PageNm |
The name of the Page using this mapper -- typically obtained from Name.
(Inherited from MapperKernel.) | |
ParentContext |
Gets/sets the parent context for this mapper.
An example of such a relationship is a mapper in the bottom pane of a subform
template with its ParentContext being that of the mapper in the top pane.
Normally you do not need to create the ParentContext, you just get it and it
is created on-demand from the current context. Normally you would only set the
context manually if the parent mapper hasn't been saved yet, but exists in memory.
(Inherited from MapperKernel.) | |
PrefNameBase |
Gets the base name for user preferences that originally were stored by MOP, but now need to be stored
by MOP:PageElementName when inter-pane navigation is in use (any maybe at other times, so we do it now
based on whether or not hosted in a ConsoleTemplate). [3/27/13 CW]
(Inherited from MapperKernel.) | |
Properties |
The mapper's Properties collection. Properties can be specified in meta-data using the mapper's
property sheet, or programmatically. Properties are used to specify many aspects of mapper
appearance and behaviour.
(Inherited from MapperKernel.) | |
Purpose |
Purpose is used to identify the purpose to which the live mapper object is currently
being put. Note that Purpose can be set to custom values by an application depending
on how the mapper is being used, but constants for a standard set of purposes can be
found in MapperPurposes.
(Inherited from MapperKernel.) | |
QuerySQL |
The explicitly set SQL or Stored Procedure call used to retrieve data for the mapper.
When QuerySQL is provided, the mapper will use it instead of generating a SELECT statement
based on its fields. In such a case the functionality of the mapper is extremely limited
and features such as sorting and filtering are typically disabled.
(Inherited from MapperKernel.) | |
RecordCount |
Returns the number of records in the current filter. Note that this number is not limited
by paging. For example, if on a datasheet displaying the first 10 records out of 53 records
matching the filter, RecordCount will return 53.
Note that calling RecordCount may require an additional database query and should be avoided
when possible. If the intent is to determine if there are zero vs. one or more records
use HasRecords instead which never requires an additional query.
Note that you can use RecordCountSafe to obtain the record count
without the possibility of an error being thrown.
(Inherited from MapperKernel.) | |
RecordsPerPage |
The number of records per page in the mapper. In mappers other than datasheets this is generally 1.
(Inherited from MapperKernel.) | |
Repository |
The repository IDatabase used by the mapper. The repository holds the mapper's meta-data.
(Inherited from MapperKernel.) | |
RollupGrouperField |
Gets the roll-up grouping field when roll-up grouping is in effect. Returns null when not in effect.
(Inherited from MapperKernel.) | |
RowCountKnowable |
Determines if the mapper can determine the total number of rows in the current filter.
(Inherited from MapperKernel.) | |
RowKey |
A key uniquely identifying the current row. In the case of multiple keys, this will
be a combined key. This key can be passed to RowKeyFilter(String) to generate a
filter for the record from which the key was obtained.
(Inherited from MapperKernel.) | |
RowLocked |
Specifies whether or not the row should be locked for the current row only. This property is
cleared by the mapper immediately prior to the RowCurrent event. An extension can then set the
property to true to lock this row only. To perform row locking on some, but not all, the fields
in a row, set the RowLocked property for the appropriate fields instead of the mapper-level
row lock, or set the mapper-level RowLocked and set the field's IgnoreRowLock
property in the fields' meta-data.
(Inherited from MapperKernel.)Note that a field will be locked for all the static reasons (e.g. if the Locked attribute is set), or if the field is row-locked, or if the mapper is row-locked and the field's IgnoreRowLock property is not set. Note that the IgnoreRowLock property applies only to mapper-level row locking and has no impact on field-level row locking. The mapper also supports a RowLockExpression property allowing the row lock condition to be specified in meta-data. The RowLockExpression is a javascript expression, typically including field references, that is evaluated with each row to initialize its RowLocked value. For row-level delete locking, see DeleteLocked. | |
TextItems |
The mapper's localized TextItem collection. For a particular instance of a mapper only the locale
(language) for the current user is loaded.
(Inherited from MapperKernel.) | |
UseBootstrap |
Gets whether or not to render for a Boostrap-base application.
(Inherited from MapperKernel.) | |
View |
The name of the mapper's underlying view or table.
This is normally loaded from meta-data during IMapper.Load().
Note that the View is used in the mapper's operational query and count
SELECT statements, but is not used for INSERT, UPDATE, or DELETE operations.
All INSERT, UPDATE, and DELETE operations are performed against the fields'
underlying tables based on each field's Table property.
(Inherited from MapperKernel.)Although the View is required, you can configure the mapper to used a Stored Procedure instead of the view by specifying the QuerySQL property. If the QuerySQL property is specified, the View will be ignored (but the Studio will still require it. Note that View can be overridden on a page-by-page basis using a page's PageView property. | |
ViewState |
The ViewState for the current page. Used to maintain filter and sort state across postbacks.
(Inherited from MapperKernel.) |