ReqParams Class

Initializes a new instance of the ReqParams class

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

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

Serves as a hash function for a particular type.

Gets the Type of the current instance.

Creates a shallow copy of the current Object.

Returns a String that represents the current Object.

"act" - The action being performed. This is informational and rarely, if ever, affects behaviour. Typically it is used for debugging.

"actpane" - The currently active pane in a ConsoleTemplate where pane navigation is in use.

"apply" - Specifies whether or not a particular action/item should be aplied. Generally "1" to apply, "0" to unapply.

"clrctype" - The type of globally cached data to be cleared. Used in conjunction with req=clrc or req=clrcrmt.

"cmd" - The command, for various uses,including event navigationl, where a command is meaningful.

"cmdid" - The command ID, for various command handling requests.

"db" - The DatabaseID of the IDatabase to use for this AJAX request.

"devcmd" - Developer command.

"div" - Depending on request, may specify either the client-side ID of a hosting element (typically a DIV), or a flag indicating where the results will be hosted 1 (or 0x00000001) indicates in-place div, 2 (or 0x00000002) indicates lightbox.

"edit" - On console panes implementing modal editing, specifies whether the console is currently in edit mode.

"eflt" - Specifies a filter for the active page element (PageElementInfo) specified in navigation to a specific page element in a console page. For a specific record you should use ElementRowKey instead. Typically this a registered filter created using RegisterReqFilterUrl(IAppContext, String, String, String, String). Often this is used in conjunction with a PrimaryKey or Filter which is applied to the main pane.

"elemreq" - The page element (PageElementInfo) request type. Specifies a request specific to the current element in the requested page where the Request is 'nav' for navigate. For example, when inter-pane navigation is in use on a console page, to navigate to a new item related to the current page's main item, a navigation like 'req=nav&elemreq=new' is performed because the main item is NOT new, while the related item is.

"erk" - Specifies the RowKey for the page element (PageElementInfo) specified in an ElementRequest. In order to apply a filter to the active pane (vs. main pane), use ElementFilter.

"faf" - The fire-and-forget ID for AJAX retrieval of fire-and-forget SQL results.

"fld" - The IMapperIFieldKey for the current AJAX request.

A registered filter to be applied to the page during a navigation. Typically this a registered filter created using RegisterReqFilterUrl(IAppContext, String, String, String, String). When navigating to a specific console pane you can also include a ElementFilter.

"fltid" - The ID of a filter to apply. Used in various contexts and with various mechanisms for specifying the filter.

"flags" - Flags used for various purposes.

"flv" - The Flavor for the current AJAX request.

"fk" - The foreign key field key as used in parent filtering.

"fkval" - The value for the foreign key field as used in parent filtering.

"genmop" - Identifies the MOP that a generic page should use. Note that the target page in a generic navigation must have the Generic attribute set. Generic navigation also requires that a GenericPEI be specified.

"genpei" - Identifies the PageElementInfo that a generic page should use. Generic navigation also requires that a GenericMOP be specified and that the PageInfo so identified is the owner of the PageElementInfo.

"id" - An ID the type of which varies widely by request.

"if" - The id of the IFrame hosting the popup window.

"lnk" - A URL. Currently used in breadcrumb handling.

"mmop" - The MOP to use in a email mailing or preview.

"map" - The Key for the current AJAX request.

"mop" - The MOP (module!page).

"navid" - The ID of the Navigator originating the request. Often used in conjunction with NavTarget.

"navtgt" - The ID of the NavTarget originating the request. Often used in conjunction with Navigator.

"nta" - The Nav Target Attributes of the NavTargetAttrs originating the request.

"opts" - Options, used in many places. Typically the options take one of two forms:

• A string where each character in a string corresponds to an option.
• A bit-value number, typically in hex, where each bit represents an option.

"origkey" - The original ParentKey (parent key), typically from a wizard request.

"origmap" - The original Mapper, typically from a wizard request.

"origmop" - The original MOP (module!page), typically from a wizard request.

"origrk" - The original RowKey (primary key), typically from a wizard request.

"pardesc" - The description of the current record of the parent page (e.g. the parent of a subform).

"parpei" = The parent PageElementID.

"parflv" - The Flavor for the ParentMapper, the mapper of the parent page (e.g. the parent of a subform).

"parkey" - The foreign key field of the parent page (e.g. the parent of a subform), typically the parent's primary key.

"parmap" - The mapper of the parent page (e.g. the parent of a subform).

"parmop" - The MOP (module!page) of the parent page (e.g. the parent of a subform).

"parrk" - The row key of the current record of the parent page (e.g. the parent of a subform).

"parukey" - Provides the REAL, unique parent key on a page that was navigated-to from a page element where the parent ViewKey in the relationship is different from the primary key of the parent mapper/page. Used in combination with ParentUniqueRowKey. This parameter is not common, but when provided generally should be favored over the ParentKey.

"parurk" - Provides the REAL, unique parent row key on a page that was navigated-to from a page element where the parent ViewKey in the relationship is different from the primary key of the parent mapper/page. Used in combination with ParentUniqueKey. This parameter is not common, but when provided generally should be favored over the ParentRowKey.

"parval" - Parent digest, containing information about the parent's context.

"pei" - The PageElementInfo reference, typically by PageElementID, but may also be by Name. When provided, URL should also include a page reference, typically MOP.

"pick" = A Picklist.

"pop" - Options for popup windows (actual browser windows as well as in-place divs, from PopupOpts.

"pk" - The primary key for the current request. Use of this parameter tends to be historical in nature and generally RowKey is used instead.

"req" - The request type. The most common is 'nav' for navigate.

"rk" - The RowKey (primary key) for the current request. The RowKey may be a compound key (see RowKey) in which case the values will be pipe-separated and ordered by ascending key name. For historical reasons sometimes PrimaryKey is used instead.

"seq" - The sequence number of the current AJAX request. Used to prevent race conditions on AJAX requests such as type-ahead handling.

"sig" - An encrypted mapper/field/pk signature used to in various immediate save and file/image upload handling.

"smfsig" - A standard signature for a MapFieldSig object generated via GenStandardEncryptedSignature(IAppContext, IField) (whose result is safe for use in a URI-component). Use FromStandardEncryptedSignature(IAppContext, String) to reconstruct the original object.

"tabid" - A unique identifier for the current browser window/tab. Unlike cookies, the TabID will be unique even for different tabs in the same browser session.

"txt" - Text. Currently used as the text corresponding to a Link in a breadcrumb.

"tries" - The number of retries for the current AJAX request.

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.