The Portrate Interview Engine

InterviewControl Members

InterviewControl overview

Protected Static (Shared) Fields

EventAfterFormRender 
EventBack 
EventBeforeFormRender 
EventBookmark 
EventCustom 
EventFinish 
EventFormError 
EventKnockout 
EventNext 
EventValidation 

Public Instance Constructors

InterviewControl ConstructorInitializes a new instance of the InterviewControl class.

Public Instance Properties

AccessKey (inherited from WebControl) Gets or sets the access key (underlined letter) that allows you to quickly navigate to the Web server control.
Attributes (inherited from WebControl) Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
BackColor (inherited from WebControl) Gets or sets the background color of the Web server control.
BindingContainer (inherited from Control) 
BookmarkBackColor 
BookmarkBorderColor 
BookmarkForeColor 
BookmarkOrientation Get/set the orientation of the bookmarks
BookmarkSelectedBackColor Set/get the background color of a selected bookmark tab
BookmarkSelectedForeColor Get/set the foreground color of a selected bookmark tab
BookmarkTabCount Get/set the number of bookmark buttons in a row
BorderColor (inherited from WebControl) Gets or sets the border color of the Web control.
BorderStyle (inherited from WebControl) Gets or sets the border style of the Web server control.
BorderWidth (inherited from WebControl) Gets or sets the border width of the Web server control.
ClientID (inherited from Control) Gets the server control identifier generated by ASP.NET.
Controls 
ControlStyle (inherited from WebControl) Gets the style of the Web server control. This property is used primarily by control developers.
ControlStyleCreated (inherited from WebControl) Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
CssClass (inherited from WebControl) Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
CurrentCampaign 
DataSource Set/get the data source for this control's data binding. The data source must be an instance of DPLFormDataModel.
Enabled (inherited from WebControl) Gets or sets a value indicating whether the Web server control is enabled.
EnableViewState (inherited from Control) Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
Font (inherited from WebControl) Gets the font properties associated with the Web server control.
ForeColor (inherited from WebControl) Gets or sets the foreground color (typically the color of the text) of the Web server control.
HasNext Returns TRUE if the current component has a 'next' form context, and FALSE if not.
HasPrevious Returns TRUE if the the current component has a 'previous' form context, and FALSE if not.
Height (inherited from WebControl) Gets or sets the height of the Web server control.
ID (inherited from Control) Gets or sets the programmatic identifier assigned to the server control.
IsDataValid Applies form-posted data and runs the validation rules on the postd data. Returns TRUE if the data is valid and FALSE if not.
NamingContainer (inherited from Control) Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
Page (inherited from Control) Gets a reference to the Page instance that contains the server control.
Parent (inherited from Control) Gets a reference to the server control's parent control in the page control hierarchy.
ShowBookmarks 
Site (inherited from Control) Gets information about the Web site to which the server control belongs.
Style (inherited from WebControl) Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
TabIndex (inherited from WebControl) Gets or sets the tab index of the Web server control.
TemplateSourceDirectory (inherited from Control) Gets the virtual directory of the Page or UserControl that contains the current server control.
ToolTip (inherited from WebControl) Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
UniqueID (inherited from Control) Gets the unique, hierarchically-qualified identifier for the server control.
Visible (inherited from Control) Gets or sets a value that indicates whether a server control is rendered as UI on the page.
Width (inherited from WebControl) Gets or sets the width of the Web server control.

Public Instance Methods

ApplyStyle (inherited from WebControl) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
CheckKnockouts Runs the knockout rules associated with the current form.
CopyBaseAttributes (inherited from WebControl) Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
DataBind (inherited from Control) Binds a data source to the invoked server control and all its child controls.
DisposeOverloaded.  
DoNext Processes the current form's data and creates the next form in the sequence.
DoPrev Places the user back on the previous page without saving any of the current data.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
FindControl (inherited from Control)Overloaded. Searches the current naming container for a server control with the specified id parameter.
GetBookmarkBackColor 
GetBookmarkBorderColor 
GetBookmarkForeColor 
GetDataValue Returns the current value of the property with the given name, replacing variable references in the given name if necessary. The value is drawn from the internal variable state and the form data model state.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
HasControls (inherited from Control) Determines if the server control contains any child controls.
MergeStyle (inherited from WebControl) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
RenderBeginTag (inherited from WebControl) Renders the HTML opening tag of the control into the specified writer. This method is used primarily by control developers.
RenderControl (inherited from Control) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
RenderEndTag (inherited from WebControl) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
ResolveUrl (inherited from Control) Converts a URL into one that is usable on the requesting client.
Restart 
SetRenderMethodDelegate (inherited from Control) 
SetVariable Sets the user variable with the given name to the given value. Send NULL as the value to remove the variable.
ToString (inherited from Object) Returns a String that represents the current Object.

Public Instance Events

AfterFormRender 
BeforeFormRender 
CampaignCompleted 
ClickBack 
ClickBookmark 
ClickCustom 
ClickNext 
DataBinding (inherited from Control) Occurs when the server control binds to a data source.
DidValidation 
Disposed (inherited from Control) Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
FormError 
Init (inherited from Control) Occurs when the server control is initialized, which is the first step in the its lifecycle.
Knockout 
Load (inherited from Control) Occurs when the server control is loaded into the Page object.
PreRender (inherited from Control) Occurs when the server control is about to render to its containing Page object.
Unload (inherited from Control) Occurs when the server control is unloaded from memory.

Protected Instance Fields

_ActionPanel 
_BookmarkPanel 
_CustomButtons 
_InputPanel 
_Msg 
_NextButton 
_PrevButton 

Protected Instance Properties

Bookmarks Get/set the list of bookmarks to be displayed
ChildControlsCreated (inherited from Control) Gets a value that indicates whether the server control's child controls have been created.
ComboBoxDefinitions Enumerates the list of combo box control names in a javascript list. This is used by the interview control to hide combo boxes when popup windows are shown that occlude a combo box.
Completed Returns true if the current campaign has been completed.
Context (inherited from Control) Gets the HttpContext object associated with the server control for the current Web request.
CurrentBookmarkIndex Get/set the current selected bookmark
Events (inherited from Control) Gets a list of event handler delegates for the control. This property is read-only.
FormDataModel Get/set the form data model. If set, then the current interview data will be replaced with the new data.
HasChildViewState (inherited from Control) Gets a value indicating whether the current server control's child controls have any saved view-state settings.
History Get/set the form history
IsTrackingViewState (inherited from Control) Gets a value that indicates whether the server control is saving changes to its view state.
RedirectUrl Get the redirection URL associated with the current form
SequenceID Get/set the ID of the current form
TagKey (inherited from WebControl) Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
TagName (inherited from WebControl) Gets the name of the control tag. This property is used primarily by control developers.
ViewState (inherited from Control) Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
ViewStateIgnoresCase (inherited from Control) Gets a value that indicates whether the StateBag object is case-insensitive.

Protected Instance Methods

AddAttributesToRender (inherited from WebControl) Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriter. This method is used primarily by control developers.
AddParsedSubObject (inherited from Control) Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
BuildProfileTree (inherited from Control) 
ClearChildViewState (inherited from Control) Deletes the view-state information for all the server control's child controls.
CreateChildControls 
CreateControlCollection (inherited from Control) Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
CreateControlStyle (inherited from WebControl) Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.
DisposeOverloaded.  
EnsureChildControls (inherited from Control) Determines whether the server control contains child controls. If it does not, it creates child controls.
Finalize 
FindControl (inherited from Control)Overloaded.  
IsLiteralContent (inherited from Control) Determines if the server control holds only literal content.
LoadViewState (inherited from WebControl) 
MapPathSecure (inherited from Control) Retrieves the physical path that a virtual path, either absolute or relative, maps to.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
OnAfterFormRender 
OnBack 
OnBeforeFormRender 
OnBookmark 
OnBubbleEvent (inherited from Control) Determines whether the event for the server control is passed up the page's UI server control hierarchy.
OnCustom 
OnDataBinding (inherited from Control) Raises the DataBinding event.
OnFinish 
OnFormError 
OnInit (inherited from Control) Raises the Init event.
OnKnockout 
OnLoad (inherited from Control) Raises the Load event.
OnNext 
OnPreRender (inherited from Control) Raises the PreRender event.
OnUnload (inherited from Control) Raises the Unload event.
Note    Server controls should perform any final cleanup, such as closing files, closing database connections, and discarding objects, during this stage of the server control lifecycle.
OnValidation 
RaiseBubbleEvent (inherited from Control) Assigns any sources of the event and its information to the control's parent.
Render 
RenderChildren (inherited from Control) Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
RenderContents (inherited from WebControl) Renders the contents of the control into the specified writer. This method is used primarily by control developers.
SaveViewState (inherited from WebControl) 
TrackViewState (inherited from WebControl) 

Protected Internal Instance Methods

AddedControl (inherited from Control) Called after a control is added to the Controls collection of another control.
RemovedControl (inherited from Control) Called after a control is removed from the Controls collection of another control.

See Also

InterviewControl Class | Portrate.Interview Namespace