Click or drag to resize

ReqParams Fields

The ReqParams type exposes the following members.

Fields
  NameDescription
Public fieldStatic memberAction
"act" - The action being performed. This is informational and rarely, if ever, affects behaviour. Typically it is used for debugging.
Public fieldStatic memberActivePane
"actpane" - The currently active pane in a ConsoleTemplate where pane navigation is in use.
Public fieldStatic memberApply
"apply" - Specifies whether or not a particular action/item should be aplied. Generally "1" to apply, "0" to unapply.
Public fieldStatic memberClearCacheType
"clrctype" - The type of globally cached data to be cleared. Used in conjunction with req=clrc or req=clrcrmt.
Public fieldStatic memberCommand
"cmd" - The command, for various uses,including event navigationl, where a command is meaningful.
Public fieldStatic memberCommandID
"cmdid" - The command ID, for various command handling requests.
Public fieldStatic memberDB
"db" - The DatabaseID of the IDatabase to use for this AJAX request.
Public fieldStatic memberDevCmd
"devcmd" - Developer command.
Public fieldStatic memberDiv
"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.
Public fieldStatic memberEditMode
"edit" - On console panes implementing modal editing, specifies whether the console is currently in edit mode.
Public fieldStatic memberElementFilter
"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.
Public fieldStatic memberElementRequest
"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.
Public fieldStatic memberElementRowKey
"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.
Public fieldStatic memberFAF
"faf" - The fire-and-forget ID for AJAX retrieval of fire-and-forget SQL results.
Public fieldStatic memberField
"fld" - The IMapperIFieldKey for the current AJAX request.
Public fieldStatic memberFilter
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.
Public fieldStatic memberFilterID
"fltid" - The ID of a filter to apply. Used in various contexts and with various mechanisms for specifying the filter.
Public fieldStatic memberFlags
"flags" - Flags used for various purposes.
Public fieldStatic memberFlavor
"flv" - The Flavor for the current AJAX request.
Public fieldStatic memberForeignKey
"fk" - The foreign key field key as used in parent filtering.
Public fieldStatic memberForeignKeyVal
"fkval" - The value for the foreign key field as used in parent filtering.
Public fieldStatic memberGenericMOP
"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.
Public fieldStatic memberGenericPEI
"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.
Public fieldStatic memberID
"id" - An ID the type of which varies widely by request.
Public fieldStatic memberIFrameID
"if" - The id of the IFrame hosting the popup window.
Public fieldStatic memberLink
"lnk" - A URL. Currently used in breadcrumb handling.
Public fieldStatic memberMailerMOP
"mmop" - The MOP to use in a email mailing or preview.
Public fieldStatic memberMapper
"map" - The Key for the current AJAX request.
Public fieldStatic memberMOP
"mop" - The MOP (module!page).
Public fieldStatic memberNavigator
"navid" - The ID of the Navigator originating the request. Often used in conjunction with NavTarget.
Public fieldStatic memberNavTarget
"navtgt" - The ID of the NavTarget originating the request. Often used in conjunction with Navigator.
Public fieldStatic memberNavTargetAttrs
"nta" - The Nav Target Attributes of the NavTargetAttrs originating the request.
Public fieldStatic memberOptions
"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.
Public fieldStatic memberOriginalKey
"origkey" - The original ParentKey (parent key), typically from a wizard request.
Public fieldStatic memberOriginalMapper
"origmap" - The original Mapper, typically from a wizard request.
Public fieldStatic memberOriginalMOP
"origmop" - The original MOP (module!page), typically from a wizard request.
Public fieldStatic memberOriginalRowKey
"origrk" - The original RowKey (primary key), typically from a wizard request.
Public fieldStatic memberParentDesc
"pardesc" - The description of the current record of the parent page (e.g. the parent of a subform).
Public fieldStatic memberParentElement
"parpei" = The parent PageElementID.
Public fieldStatic memberParentFlavor
"parflv" - The Flavor for the ParentMapper, the mapper of the parent page (e.g. the parent of a subform).
Public fieldStatic memberParentKey
"parkey" - The foreign key field of the parent page (e.g. the parent of a subform), typically the parent's primary key.
Public fieldStatic memberParentMapper
"parmap" - The mapper of the parent page (e.g. the parent of a subform).
Public fieldStatic memberParentMOP
"parmop" - The MOP (module!page) of the parent page (e.g. the parent of a subform).
Public fieldStatic memberParentRowKey
"parrk" - The row key of the current record of the parent page (e.g. the parent of a subform).
Public fieldStatic memberParentUniqueKey
"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.
Public fieldStatic memberParentUniqueRowKey
"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.
Public fieldStatic memberParentVals
"parval" - Parent digest, containing information about the parent's context.
Public fieldStatic memberPEI
"pei" - The PageElementInfo reference, typically by PageElementID, but may also be by Name. When provided, URL should also include a page reference, typically MOP.
Public fieldStatic memberPicklist
"pick" = A Picklist.
Public fieldStatic memberPopupOptions
"pop" - Options for popup windows (actual browser windows as well as in-place divs, from PopupOpts.
Public fieldStatic memberPrimaryKey
"pk" - The primary key for the current request. Use of this parameter tends to be historical in nature and generally RowKey is used instead.
Public fieldStatic memberRequest
"req" - The request type. The most common is 'nav' for navigate.
Public fieldStatic memberRowKey
"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.
Public fieldStatic memberSequence
"seq" - The sequence number of the current AJAX request. Used to prevent race conditions on AJAX requests such as type-ahead handling.
Public fieldStatic memberSignature
"sig" - An encrypted mapper/field/pk signature used to in various immediate save and file/image upload handling.
Public fieldStatic memberStdMapFieldSig
"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.
Public fieldStatic memberTabID
"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.
Public fieldStatic memberText
"txt" - Text. Currently used as the text corresponding to a Link in a breadcrumb.
Public fieldStatic memberTries
"tries" - The number of retries for the current AJAX request.
Top
See Also