ReportBuilder MembersA Sandcastle Documented Class Library

The ReportBuilder type exposes the following members.
Constructors

  NameDescription
Public methodReportBuilder
Initializes a new instance of the ReportBuilder 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 methodbtnManageToggle_Click
Toggles the manage reports link button.
Protected methodbtnPreviewToggle_Click
Toggles the preview window for this filter builder form.
Protected methodbtnRefresh_Click
Does nothing except force a postback.
Protected methodbtnSaveRefresh_Click
Refreshes the page with a clean page load.
Protected methodbtnStep1Cancel_Click
Event handler for the cancel button on the step1 form.
Protected methodbtnStep1Next_Click
Event handler for the next button on the step1 form.
Protected methodbtnStep2Cancel_Click
Step two cancel button.
Protected methodbtnStep2Next_Click
Step two next button.
Protected methodbtnStep3Cancel_Click
Step three cancel button.
Protected methodbtnStep3Next_Click
Step three save button.
Protected methodbtnStep3Skip_Click
Step three skip button.
Protected methodbtnStep4Cancel_Click
Step four cancel button.
Protected methodbtnStep4Save_Click
Step four save button.
Public methodBuildForm
Builds the dynamic form.
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 methodGenerateFilterBuilderPassThroughData
Generates a filter builder pass through data object.
Private methodGenerateSaveValuesStep1
Generate all the values needed to perform a step1 save on this report.
Private methodGenerateSaveValuesStep2
Generate all the values needed to perform a step2 save on this report.
Private methodGenerateSaveValuesStep3
Generate all the values needed to perform a step3 save on this report.
Private methodGenerateStatisticBuilderPassThroughData
Generates a statistic builder pass through data object.
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 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.)
Protected methodGetReportBuilderTitle
Returns the proper title for the current form mode.
Public methodHasPagePerm
Returns true if the user has the current perm enabled.
(Inherited from BasePageStandard.)
Private methodHideEditMsg
Hides the edit filter message.
Private methodHideReportManagePanel
Hide the statistic manage panel.
Private methodHideReportManagePanelPassive
Hide the statistic manage panel. Do not call BuildForm.
Private methodHideReportPreviewPanel
Hides the filter preview panel.
Private methodHideReportPreviewPanelPassive
Hides the report preview panel but doesn't cal build form.
Private methodInsertNewReportStep1
Inserts a new filter record into the database.
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.)
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 methodProcessReportCalcConfig
Processes the calculation config entries for the given report calculation.
Private methodProcessReportSaveStep1 
Overloaded method version defaults to autoSave = false;
Private methodProcessReportSaveStep1(Boolean)
Saves the data received in the step1 form.
Private methodProcessReportSaveStep2 
Overloaded method version defaults to autoSave = false;
Private methodProcessReportSaveStep2(Boolean)
Saves the data received in the step2 form.
Private methodProcessReportSaveStep3 
Overloaded method version defaults to autoSave = false;
Private methodProcessReportSaveStep3(Boolean)
Saves the data received in the step3 form.
Private methodProcessTableJoinSave
Process the table join form save.
Private methodProcessTableSortSave
Process saving the table sort form save.
Private methodProcessTableTopSave
Process the table select top form save.
Private methodRefreshList
Rebuilds the list data from the post back info
Protected methodreportPassThroughTest_Click
Test event handler that drives the pass through mode of this page.
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 methodShowCantSaveForm
Displays the cant save version of this page. If no filters are avtice this form is visible.
Private methodShowEditMsg
Shows the edit filter message, lets end users know they are editing an existing filter.
Private methodShowReportManagePanel
Shows the manage statistic panel.
Private methodShowReportManagePanelPassive
Shows the manage statistic panel. Does not call BuildForm.
Private methodShowReportPreviewPanel
Shows the filter preview panel.
Private methodShowReportPreviewPanelPassive
Shows the report preview window but doesn't call rebuild form.
Private methodShowReportStep1Form
Shows the step1 form, hides all other forms.
Private methodShowReportStep2Form
Shows the step2 form, hides all other forms.
Private methodShowReportStep3Form
Shows the step3 form, hides all other forms.
Private methodShowReportStep4Form
Shows the step4 form, hides all other forms.
Private methodShowStepForm
Displays the proper form for each step.
Private methodToggleReportManage
Toggle the filter manage button text.
Private methodToggleReportPreview
Toggles the report preview control.
Private methodUpdateExistingReportStep1
Updates an existing filter record in the database.
Private methodUpdateExistingReportStep2
Updates an existing report record in the database.
Private methodUpdateExistingReportStep3
Updates an existing report record in the database.
Private methodUpdateShowManageText
Updates the text on the 'Manage On' toggle button.
Private methodUpdateShowPreviewText
Updates the text on the 'Preview On' toggle button.
Private methodValidateTableSort
Validates the table sort form.
Private methodValidateTableTop
Validates the table top form.
Back to Top
Fields

  NameDescription
Private fieldautoSave
Controls the auto save feature of this form.
Protected fieldbnp
bnp control.
Protected fieldbtnSaveRefresh
btnSaveRefresh control.
Protected fieldbtnStep1Cancel
btnStep1Cancel control.
Protected fieldbtnStep1ManageToggle
btnStep1ManageToggle control.
Protected fieldbtnStep1Next
btnStep1Next control.
Protected fieldbtnStep1PreviewToggle
btnStep1PreviewToggle control.
Protected fieldbtnStep1Refresh
btnStep1Refresh control.
Protected fieldbtnStep2Cancel
btnStep2Cancel control.
Protected fieldbtnStep2ManageToggle
btnStep2ManageToggle control.
Protected fieldbtnStep2Next
btnStep2Next control.
Protected fieldbtnStep2PreviewToggle
btnStep2PreviewToggle control.
Protected fieldbtnStep2Refresh
btnStep2Refresh control.
Protected fieldbtnStep3Cancel
btnStep3Cancel control.
Protected fieldbtnStep3ManageToggle
btnStep3ManageToggle control.
Protected fieldbtnStep3Next
btnStep3Next control.
Protected fieldbtnStep3PreviewToggle
btnStep3PreviewToggle control.
Protected fieldbtnStep3Refresh
btnStep3Refresh control.
Protected fieldbtnStep3Skip
btnStep3Skip control.
Protected fieldbtnStep4Cancel
btnStep4Cancel control.
Protected fieldbtnStep4Save
btnStep4Save control.
Protected fieldcbOverwrite
cbOverwrite control.
Protected fieldcbReportPublic
cbReportPublic control.
Protected fielddvEditReportMsg
dvEditReportMsg control.
Protected fielddvJoinInstr
dvJoinInstr control.
Protected fielddvManage
dvManage control.
Protected fielddvManageInner
dvManageInner control.
Protected fielddvPanelHolder
dvPanelHolder control.
Protected fielddvPanelHolderSort
dvPanelHolderSort control.
Protected fielddvPreview
dvPreview control.
Protected fielddvReportCantSaveControls
dvReportCantSaveControls control.
Protected fielddvReportEmptyPreview
dvReportEmptyPreview control.
Protected fielddvReportFilterPreview
dvReportFilterPreview control.
Protected fielddvReportStatPreview
dvReportStatPreview control.
Protected fielddvReportStep1
dvReportStep1 control.
Protected fielddvReportStep2
dvReportStep2 control.
Protected fielddvReportStep3
dvReportStep3 control.
Protected fielddvReportStep4
dvReportStep4 control.
Protected fielddvSortInstr
dvSortInstr control.
Protected fielddvStep1Overwrite
dvStep1Overwrite control.
Protected fielddvStep1PanelHolder
dvStep1PanelHolder control.
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.)
Protected fieldfilterName
Holds the name of the current filter.
Protected fieldfilterQueryAsHtml
Stores the html version of the current report's filter clause.
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 fieldformMode
Holds the current form mode, loaded from the session.
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.)
Private fieldIS_POSTBACK (Inherited from BasePageStandard.)
Protected fieldisLoggedIn
Is set to true if the user is currently logged in.
(Inherited from BasePageStandard.)
Protected fieldkey
A secret key needed to talk to the web service client.
(Inherited from BasePageStandard.)
Protected fieldlblTables
lblTables control.
Private fieldlogging
Controls logging on this page.
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.
Protected fieldqueryAsHtml
Stores the html version of the current report.
Protected fieldreportPassThroughTest
reportPassThroughTest control.
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 fieldshowManage
Controls the use of the show manage button.
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.)
Protected fieldtxtReportDesc
txtReportDesc control.
Protected fieldtxtReportName
txtReportName control.
Protected fieldtxtTop
txtTop 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