FilterBuilder MembersA Sandcastle Documented Class Library

The FilterBuilder type exposes the following members.
Constructors

  NameDescription
Public methodFilterBuilder
Initializes a new instance of the FilterBuilder class
Back to Top
Methods

  NameDescription
Public methodAppLogLogin
Simplified method for logging application login attempts.
(Inherited from BasePageStandard.)
Public methodAppLogLogout
Simplified method for logging application logout attempts.
(Inherited from BasePageStandard.)
Public methodAppLogPage
Simplified method for logging application page access.
(Inherited from BasePageStandard.)
Protected methodbtnBackPt_Click
Used in pass through mode to go back to the previous step.
Protected methodbtnCancel_Click
Cancels this operation and returns the user to the FintIt page.
Protected methodbtnDel_Click
Delete the selected filter builder panels.
Protected methodbtnGroup_Click
Group the selected filter builder panels.
Protected methodbtnInsert_Click
Insert a filter builder panel below the selected panel.
Protected methodbtnNew_Click
Adds a new filter builder panel to the form.
Protected methodbtnNew1_Click
Sets the form for a new filter entry.
Protected methodbtnNextPt_Click
Used in pass through mode to move onto the next step with validation.
Protected methodbtnOpen_Click
Opens a filter from the current filter builder form.
Protected methodbtnPreviewToggle_Click
Toggles the preview window for this filter builder form.
Protected methodbtnRefresh_Click
Does nothing except force a postback.
Protected methodbtnSave_Click
Shows the save for for this filter builder form.
Protected methodbtnSaveBack_Click
Returns the user back to the builder part of the filter builder page.
Protected methodbtnSaveSave_Click
Saves the current filter object.
Protected methodbtnSaveSaveOpen_Click
Saves the current filter object and opens it. Opening a filter is not yet supported.
Protected methodbtnSelectAll_Click
Selects all the filter bilder panels on the current form.
Protected methodbtnShadingToggle_Click
Toggles the display of alternately shaded filter builder panels for the same grouping level.
Protected methodbtnSkipPt_Click
Used in pass through mode to skip this step, no validation.
Protected methodbtnUnGroup_Click
Ungroup the selected filter builder panels.
Protected methodbtnUnselectAll_Click
Unselects all the filter builder panels on the current form.
Private methodBuildCodedQuery
Builds a DB coded SqlQuery object from the FilterBuilderPanel list.
Public methodBuildForm
Builds the dynamic form.
Private methodBuildLiteralQuery
Builds a human friendly SqlQuery object from the FilterBuilderPanel list.
Private methodBuildQuery
Builds an SqlQuery object from the FilterBuilderPanel list.
Private methodCheckFilterCount
Public methodCheckForExpiration
Checks to see if the given user account is expired or not
(Inherited from BasePageStandard.)
Public methodCheckForInjection
Checks for sql statements in queries.
(Inherited from BasePageStandard.)
Public methodCheckPagePermission
Calling method for CheckPermissions, loads up a reference to the service client before calling the CheckPermissions method.
(Inherited from BasePageStandard.)
Public methodCheckPermissions
Checks the current page permissions by pageName, userId, and userRolesId.
(Inherited from BasePageStandard.)
Private methodGenerateSaveValues
Generate all the values needed to update or save this filter.
Protected methodGetActiveFilter
Returns the active filter from the filter object manager if there is one.
(Inherited from BasePageStandard.)
Protected methodGetActiveFilterActiveReport
Returns the ReportObj if there is an active filter with a report at the Session stored index 'reportIndex'.
(Inherited from BasePageStandard.)
Protected methodGetActiveFilterActiveStat
Returns the ReportObj if there is an active filter with a report at the Session stored index 'reportIndex'.
(Inherited from BasePageStandard.)
Protected methodGetActiveFilterId
Returns the active filter's filter ID.
(Inherited from BasePageStandard.)
Protected methodGetActiveFilterReportAt
Returns the active filter's report at the provided index.
(Inherited from BasePageStandard.)
Protected methodGetActiveFilterStatAt
Returns the active filter's statistic at the provided index.
(Inherited from BasePageStandard.)
Protected methodGetActiveReportId
Returns the active report id or new if the report is a new report.
(Inherited from BasePageStandard.)
Protected methodGetActiveReportIndex
Returns the active report index.
(Inherited from BasePageStandard.)
Protected methodGetActiveReportIndexStr
Returns the active report index as a string.
(Inherited from BasePageStandard.)
Protected methodGetActiveStatId
Returns the active report id or new if the report is a new report.
(Inherited from BasePageStandard.)
Protected methodGetActiveStatIndex
Returns the active report index.
(Inherited from BasePageStandard.)
Protected methodGetActiveStatIndexStr
Returns the active report index as a string.
(Inherited from BasePageStandard.)
Public methodGetAdminUserRole
Returns the Admin user role id as a string.
(Inherited from BasePageStandard.)
Protected methodGetFilterBuilderTitle
Returns the current title of this page.
Protected methodGetFilterObjManager
Returns the filter object manager.
(Inherited from BasePageStandard.)
Protected methodGetHasActiveFilter
Returns true if there is an active filter.
(Inherited from BasePageStandard.)
Protected methodGetHasActiveFilterActiveReport
Returns true if there is an active filter with a report at the Session stored index 'reportIndex'.
(Inherited from BasePageStandard.)
Protected methodGetHasActiveFilterActiveStat
Returns true if there is an active filter with a stat at the Session stored index 'statIndex'.
(Inherited from BasePageStandard.)
Protected methodGetHasActiveFilterReportAt
Returns true if there is an active filter with a report at the provided index.
(Inherited from BasePageStandard.)
Protected methodGetHasActiveFilterStatAt
Returns true if there is an active filter with a stat at the provided index.
(Inherited from BasePageStandard.)
Protected methodGetHasFilterObjManager
Returns true if there is a current filter object manager.
(Inherited from BasePageStandard.)
Public methodGetP4sPsmsUserRole
Returns the P4s Psms user role id as a string.
(Inherited from BasePageStandard.)
Public methodHasPagePerm
Returns true if the user has the current perm enabled.
(Inherited from BasePageStandard.)
Private methodHideEditMsg
Hides the edit filter message.
Private methodHideFilterPreviewPanel
Hides the filter preview panel.
Private methodHideFilterPreviewPanelPassive
Hides the filter preview panel.
Protected methodiconPanel_ChooseIcon
Chooses an icon from the icon panel.
Private methodInsertNewFilter
Inserts a new filter record into the database.
Private methodInsertNewFilterActive
Inserts a new filter and makes sets its active/inactive state.
Protected methodIsLoggedIn
Used to test whether the current user is logged in or not.
(Inherited from BasePageStandard.)
Public methodLoadPageFeaturePerms
Loads all the feature perms for this page.
(Inherited from BasePageStandard.)
Private methodNormalizeIndexes
Normalizes the panel indexes in case of inserts or deletes.
Protected methodPage_Error
Calls Page_Error from base class, BasePageStandard.
(Overrides BasePageStandard Page_Error(Object, EventArgs).)
Protected methodPage_Load
Calls Page_Load from base class, BasePageStandard.
(Overrides BasePageStandard Page_Load(Object, EventArgs).)
Protected methodPrepEditForm
Loads the filter stored in the session and builds a form based on the filter contents.
Protected methodPrepNewForm
Override OnInit method to add dynamic home menu drop down lists.
Private methodProcessFilterSave 
Process a filter object for saving.
Private methodProcessFilterSave(Boolean, Boolean)
Processes a filter object for saving, optionally opens that filter object.
Private methodProcessOpenFilter
Process open filter request.
Private methodRefreshList
Rebuilds the list data from the post back info
Public methodRunAppLogLogin
Async execution of the app login method.
(Inherited from BasePageStandard.)
Public methodRunAppLogLogout
Async execution of the app logout method.
(Inherited from BasePageStandard.)
Public methodRunAppLogPage
Async execution of the app page method.
(Inherited from BasePageStandard.)
Private methodSetSession (Inherited from BasePageStandard.)
Private methodShowBuildForm
Shows the build form controls.
Private methodShowEditMsg
Shows the edit filter message, lets end users know they are editing an existing filter.
Private methodShowFilterPreviewPanel
Shows the filter preview panel.
Private methodShowFilterPreviewPanelPassive
Shows the filter preview panel.
Private methodShowSaveForm
Shows the save form controls.
Private methodToggleFilterPreview
Toggles the filter preview control
Private methodUpdateAltRowShadingText
Updates the alternate shading button based on the current toggle value.
Private methodUpdateExistingFilter
Updates an existing filter record in the database.
Private methodUpdateShowPreviewText
Updates the text on the 'Preview On' toggle button.
Back to Top
Fields

  NameDescription
Private fieldaltRowShading
Controls the use of alternate color shading on the form.
Private fieldautoSave
Controls the auto save feature of this form.
Protected fieldbnp
bnp control.
Protected fieldbtnAltShadingToggle
btnAltShadingToggle control.
Protected fieldbtnBackPt
btnBackPt control.
Protected fieldbtnCancel
btnCancel control.
Protected fieldbtnDel
btnDel control.
Protected fieldbtnGroup
btnGroup control.
Protected fieldbtnInsert
btnInsert control.
Protected fieldbtnNew
btnNew control.
Protected fieldbtnNew1
btnNew1 control.
Protected fieldbtnNextPt
btnNextPt control.
Protected fieldbtnOpen
btnOpen control.
Protected fieldbtnPreviewToggle
btnPreviewToggle control.
Protected fieldbtnRefresh
btnRefresh control.
Protected fieldbtnSave
btnSave control.
Protected fieldbtnSaveBack
btnSaveBack control.
Protected fieldbtnSaveSave
btnSaveSave control.
Protected fieldbtnSaveSaveOpen
btnSaveSaveOpen control.
Protected fieldbtnSelectAll
btnSelectAll control.
Protected fieldbtnSkipPt
btnSkipPt control.
Protected fieldbtnUnGroup
btnUnGroup control.
Protected fieldbtnUnselectAll
btnUnselectAll control.
Private fieldbuttonWidth
Used in calculating the width of the pass through button bar.
Protected fieldcbFilterPublic
cbFilterPublic control.
Protected fieldcbOverwrite
cbOverwrite control.
Protected fieldcssLowerBtnBar
Css string that controls the display of the lower button bar.
Protected fieldcssLowerBtnBarPt
Css string that controls the display of the lower pass through button bar.
Protected fieldcssLowerBtnBarPtWidth
Css string that holds the lower button bar's width.
Protected fielddvEditFilterMsg
dvEditFilterMsg control.
Protected fielddvFilterBuildControls
dvFilterBuildControls control.
Protected fielddvFilterError
dvFilterError control.
Protected fielddvFilterSaveControls
dvFilterSaveControls control.
Protected fielddvInstructions
dvInstructions control.
Protected fielddvPanelHolder
dvPanelHolder control.
Protected fielddvPreview
dvPreview control.
Protected fielddvSavePanelHolder
dvSavePanelHolder control.
Private fieldemptyButtonWidth
Used in calculating the width of the pass through button bar.
Protected fieldfhp
fhp control.
Protected fieldfileName
The current page as a file name.
(Inherited from BasePageStandard.)
Protected fieldfileNameShort
The current page as a file name with no extension.
(Inherited from BasePageStandard.)
Private fieldfilterBuilderDefaultTitle
Stores the default title for this form.
Protected fieldfilterBuilderTitle
Stores the current title for this form.
Protected fieldforceNoColumnTest
Driven by a web config setting to force a no data returned test on every data loading/viewing page.
(Inherited from BasePageStandard.)
Protected fieldforceNoDataTest
Driven by a web config setting to force a no data returned test on every data loading/viewing page.
(Inherited from BasePageStandard.)
Protected fieldforceNoReportTest
Driven by a web config setting to force a no data returned test on every data loading/viewing page.
(Inherited from BasePageStandard.)
Protected fieldForm1
Form1 control.
Private fieldformError
Represents whether the current filter builder form has an error.
Private fieldformMode
Represents the current state of the filter builder form.
Protected fieldiconPanel
iconPanel control.
Protected fieldignoreInjection
Ignore the injection checks while true.
(Inherited from BasePageStandard.)
Protected fieldignoreTimeout
If set to true ignores timeout processing and redirection.
(Inherited from BasePageStandard.)
Protected fieldimgFilterIcon
imgFilterIcon control.
Private fieldIS_POSTBACK (Inherited from BasePageStandard.)
Protected fieldisLoggedIn
Is set to true if the user is currently logged in.
(Inherited from BasePageStandard.)
Protected fieldisPassThrough
Represents whether the current filter builder form is in pass through mode.
Protected fieldkey
A secret key needed to talk to the web service client.
(Inherited from BasePageStandard.)
Protected fieldlblFilterIconId
lblFilterIconId control.
Protected fieldlblFilterIconName
lblFilterIconName control.
Private fieldlistKey
The session key used to store the list of criteria entries.
Private fieldlogging
Controls logging on this page.
Public fieldlogs
Possibly used by FilterControlPanel children for logging, Session["logs"] may also be used.
Private fieldStatic memberMAX_INDENT_LEVEL
Controls the maximum indent level for drawing purposes.
Protected fieldmaxBulkExpRows
The maximum number of rows supported in a bulk export operation/
(Inherited from BasePageStandard.)
Protected fieldmaxExpRows
Sets the maximum number of rows donwloads will be supported on.
(Inherited from BasePageStandard.)
Protected fieldmaxJsonCols
The maximum number of JSON columns supported in converting a DataTable to JSON format.
(Inherited from BasePageStandard.)
Protected fieldmaxJsonRows
The maximum number of JSON rows supported in converting a DataTable to JSON format.
(Inherited from BasePageStandard.)
Protected fieldmaxRowReturn
Sets the maximum row return for the data grid view.
(Inherited from BasePageStandard.)
Protected fieldmaxToolRows
The maximum number of rows allowed in complex tools.
(Inherited from BasePageStandard.)
Protected fieldmessage
message control.
Protected fieldmfp
mfp control.
Protected fieldmmp
mmp control.
Private fieldMSG (Inherited from BasePageStandard.)
Protected fieldpageFeaturePerms
List of features permissions granted by page.
(Inherited from BasePageStandard.)
Protected fieldpageIntro
pageIntro control.
Private fieldpd
Stores the current pass through object, if in pass through mode.
Protected fieldqueryAsHtml
Stores the html version of the current filter.
Protected fieldrootDir
THe current parent directory of the page.
(Inherited from BasePageStandard.)
Protected fieldrUrl
The current URL of this page.
(Inherited from BasePageStandard.)
Protected fieldrUrlLower
The current URL of this page in lowercase form.
(Inherited from BasePageStandard.)
Protected fieldScriptmanager1
Scriptmanager1 control.
Private fieldSession
Static self reference to the current Session. New keyword lets the system know we are intentionally overriding the Session.
(Inherited from BasePageStandard.)
Protected fieldsessionPrefix
Stores the local page's session prefix, used for advanced session management.
(Inherited from BasePageStandard.)
Private fieldshowEditMsg
Controls th euse of the show edit message control.
Private fieldshowPreview
Controls the use of the show preview button.
Protected fieldsvc
A P4S3 Web Service client.
(Inherited from BasePageStandard.)
Protected fieldtempDir
The local temp directory for this web application.
(Inherited from BasePageStandard.)
Private fieldtmpStr
Private tmeporary string.
Private fieldtqCoded
Private fieldtqLiteral
Protected fieldtxtFilterDesc
txtFilterDesc control.
Protected fieldtxtFilterName
txtFilterName control.
Protected fieldupanFilterIcon
upanFilterIcon control.
Protected fieldupPanel1
upPanel1 control.
Protected fielduserId
The active userId.
(Inherited from BasePageStandard.)
Protected fielduserRoleId
The current user's role id.
(Inherited from BasePageStandard.)
Protected fieldWaitingPopup1
WaitingPopup1 control.
Back to Top
See Also