FilterBuilderPassThroughData MembersA Sandcastle Documented Class Library

The FilterBuilderPassThroughData type exposes the following members.
Constructors

  NameDescription
Public methodFilterBuilderPassThroughData
Generic constructor.
Back to Top
Methods

  NameDescription
Public methodGetActionComplete
Returns true if this action has been completed.
Public methodGetActive
Returns true if this pass through object should be acted on.
Public methodGetBackBtnOn
Returns true if the back button should be visible.
Public methodGetBackLink
Returns the link to use if the back button is clicked.
Public methodGetEditMode
Returns true if this object contians filter data for edit mode.
Public methodGetFormModeKey
Returns the form mode key.
Public methodGetInstructions
Return the instructions for this pass through object.
Public methodGetMessage
Returns the message for this pass through object.
Public methodGetNextBtnOn
Returns true if the next button should be visible.
Public methodGetNextLink
Gets the link to process if the next button is clicked.
Public methodGetPageIntro
Gets the page intro html to be displayed by the filter builder page.
Public methodGetPassThroughKey
Gets the key this pass through object was delivered with.
Public methodGetPayloadCoded
Returns the coded filter query built by the filter builder page.
Public methodGetPayloadLiteral
Returns the literal filter query built by the filter builder page.
Public methodGetReturnKey
Gets the return key for this pass through event.
Public methodGetSessionPrefixMod
Returns the session prefix modifier to use for this pass through event.
Public methodGetShowManage
Returns the show manage bool holder.
Public methodGetShowPreview
Gets the show preview bool, holder.
Public methodGetSkipBtnOn
Returns true if the skip button should be visible.
Public methodGetSkipLink
Gets the link to process if the skip button is clicked.
Public methodGetTag1
Returns the generic object holder, tag1.
Public methodGetTag2
Returns the generic object holder, tag2.
Public methodGetTag3
Returns the generic object holder, tag3.
Public methodGetTitle
Returns the title to display when this pass through event is acted on.
Public methodGetTouched
Returns true if this pass through object has been touched by the pass to page.
Public methodSetActionComplete
Sets true if this pass through event has been acted on to completion.
Public methodSetActive
Sets if this pass through object should be acted on.
Public methodSetBackBtnOn
Sets the display value of the back button.
Public methodSetBackLink
Sets the back button link.
Public methodSetEditMode
Sets the current edit mode of this pass through object.
Public methodSetFormModeKey
Sets the form mode key, a session key for holding the form mode.
Public methodSetInstructions
Set the display instructions for this pass through object.
Public methodSetMessage
Sets the message for this pass through object.
Public methodSetNextBtnOn
Sets the display value for the next button.
Public methodSetNextLink
Sets the next button link.
Public methodSetPageIntro
Sets the page intro html to be displayed by the filter builder page.
Public methodSetPassThroughKey
Sets the current key this pass through object was delivered with.
Public methodSetPayloadCoded
Sets the coded filter query built by the filter builder page.
Public methodSetPayloadLiteral
Sets the literal filter query built by the filter builder page.
Public methodSetReturnKey
Sets the return key where this object is expected to be stored in the session for the return trip.
Public methodSetSessionPrefixMod
Set the session prefix modifier for this pass through event.
Public methodSetShowManage
Sets the show manage bool holder.
Public methodSetShowPreview
Sets the show preview bool holder.
Public methodSetSkipBtnOn
Sets the display value for the skip button.
Public methodSetSkipLink
Sets the skip button link.
Public methodSetTag1
Sets the generic object holder, tag1.
Public methodSetTag2
Sets the generic object holder, tag2.
Public methodSetTag3
Sets the generic object holder, tag3.
Public methodSetTitle
Sets the title to use when this pass through event is acted on.
Public methodSetTouched
Sets the touch value of this object. Pass to page should touch this object after verification. Pages should ignore touched objects on new page post, i.e. not a post back. This lets pages know when to reset to normal and ignore the pass through process.
Back to Top
Fields

  NameDescription
Private fieldactionComplete
Private fieldactive
Private fieldbackBtnOn
Private fieldbackLink
Private fieldeditMode
Private fieldformModeKey
Private fieldinstructions
Private fieldmessage
Private fieldnextBtnOn
Private fieldnextLink
Private fieldpageIntro
Private fieldpassThroughKey
Private fieldpayloadCoded
Private fieldpayloadLiteral
Private fieldreturnKey
Private fieldsessionPrefixMod
Private fieldshowManage
Private fieldshowPreview
Private fieldskipBtnOn
Private fieldskipLink
Private fieldtag1
Private fieldtag2
Private fieldtag3
Private fieldtitle
Private fieldtouched
Back to Top
See Also