MapperExtensionBase Class |
Abstract base class for mapper extensions.
This class is provided primarily for internal use and custom application extensions
should not normally derive from this class, but rather from MapperExtensionKernel
for untyped extensions or TypedMapperExtensionT for typed extensions.
As with all extensions and extension base classes, the class implements the IExtension interface and response to ExtensionEvents.
Inheritance HierarchySystemObject
NetQuarry.DataMapperExtensionBase
NetQuarry.DataMapperExtensionKernel
NetQuarry.DataTypedMapperExtensionT
NetQuarry.DataMapperExtensionBase
NetQuarry.DataMapperExtensionKernel
NetQuarry.DataTypedMapperExtensionT
Namespace: NetQuarry.Data
Assembly: EAP.Mapper (in EAP.Mapper.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe MapperExtensionBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MapperExtensionBase |
Constructs a new instance of this object.
|
Properties| Name | Description | |
|---|---|---|
 | Application |
Returns the application object (from IMapper.Application)
|
| Database |
Returns the main database object (from IMapper.Database)
|
 | IsPlatform |
Gets whether or not the extension is a platform extension vs. a custom extension.
|
| Mapper |
Returns the Mapper object that this extension is attached to.
|
| MapperCommandsHandled |
Gets the semi-colon separated list of MapperCommands handled by this extension.
|
| ParentKeyValue |
Gets the request's parent record's row key value under most circumstances including: datasheets, subforms,
popup new forms, and datasheet drilldowns.
|
| Properties |
Returns this instance's properties.
|
 | TextItems |
Returns a collection of TextItems loaded from metadata related to this component.
|
Methods| Name | Description | |
|---|---|---|
 | Equals | (Inherited from Object.) |
| ExtensionCommand |
Handle extension commands.
|
| 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.) |
| GetText |
Get the specified localized text for this mapper. Obtaining the text is
a four step process:
1) Look for the text item in the mapper's TextItems collection,
2) if not found, look for the item in the extension's TextItems collection,
3) if not found, look for the item in the locale resource file,
4) if not found, use the provided defaultText.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HandleEvent |
Handler for all events.
|
| Info |
Return requested information about the extension.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnEvent |
This method is called to fire an event. The extension responds to this event.
|
| OnSetOwner |
Called when the Owner of this extension is set by the extension loader.
|
| OnUnload |
Notifies the extension that it should perform any cleanup necessary just prior to being unloaded.
|
| ToString | (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | _logRowCurrent |
Specifies whether or not log RowCurrent events to the devlog.
Such logging also depends on NoDebug.
|
| _mapper |
The attached mapper object to derived classes
|
Extension Methods| 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.) |
See Also