Click or drag to resize

ScanWidget Class

A TWAIN scanner widget used to capture images from a scanner accessible from the client machine. This requires the Dynamsoft Dynamic Twain ActiveX/Plugin.
Inheritance Hierarchy

Namespace:  NetQuarry.Data.WebMappers
Assembly:  EAP.WebMappers (in EAP.WebMappers.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class ScanWidget : DivWidgetBase

The ScanWidget type exposes the following members.

Constructors
  NameDescription
Public methodScanWidget
Initializes a new instance of the ScanWidget class
Top
Properties
  NameDescription
Protected propertyCaption
Gets the caption.
(Overrides DivWidgetBaseCaption.)
Protected propertyCssClass
A Css class to be added to the widget for widget-specific styling.
(Inherited from DivWidgetBase.)
Protected propertyDivOpts
Provide widget-specific options. In this case, the widget should remain hidden since there's no UI in the widget and we want the scanning to commences upon widget load.
(Overrides DivWidgetBaseDivOpts.)
Protected propertyFilterID
Gets the client-side filter control ID from the request "id" parameter.
(Inherited from DivWidgetBase.)
Protected propertyFilterOptions
Get the field filter options to apply to the widget. Note that only a few of the FieldFilterOptions have any effect on a filter widget.
(Inherited from DivWidgetBase.)
Protected propertyFilterText
Gets the filter text from the request "txt" parameter.
(Inherited from DivWidgetBase.)
Protected propertyMOP
The MOP of the page requesting the filter widget presentation.
(Inherited from DivWidgetBase.)
Protected propertyUseBootstrap
Gets whether or not Bootstrap is being used.
(Inherited from DivWidgetBase.)
Protected propertyWidgetID
Gets the client-side widget ID from the request "wid" parameter.
(Inherited from DivWidgetBase.)
Protected propertyWidgetOptions
Get the filter widget options (a set of character flags that may be widget-specific).
  • a - Include Apply Now button.
  • u - Unlimited list of items.
(Inherited from DivWidgetBase.)
Protected propertyWidgetWidth
Gets the widget width, in pixels.
(Overrides DivWidgetBaseWidgetWidth.)
Top
Methods
  NameDescription
Protected methodAddFormGroupBoot
Creates a Bootstrap "control-group" inside a Bootstrap "form-group", and adds the "form-group" to the provided container. If includeControlsContainer is specified then a "controls" element is created inside the "control-group". The innermost of these is returned.
(Inherited from DivWidgetBase.)
Protected methodAddLabelledControlGroupBoot
Creates a Bootstrap "form-group" with a label and single control associated with that label and adds the "form-group" to the provided container.
(Inherited from DivWidgetBase.)
Protected methodAddSingleControlGroupBoot
Creates a Bootstrap "form-group" with a single control and adds the "form-group" to the provided container.
(Inherited from DivWidgetBase.)
Protected methodCloseJS
Generates standard standard widget close javascript.
(Inherited from DivWidgetBase.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetText
Get the specified localized text. Obtaining the text is a two step process: 1) Look for the item specified by ids in the locale resource file, 2) if not found, use the provided defaultText.
(Inherited from DivWidgetBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOkCancelControlsBoot
Generate a standard OK/Cancel button Bootstrap "controls" container DIV for use in non-Bootstrap layouts. Use OkCancelRow(IAppContext, Button, Button) for use native Bootstrap layouts.
(Inherited from DivWidgetBase.)
Protected methodOkCancelRow
Generate a standard OK/Cancel button row for use in non-Bootstrap layouts. Use OkCancelControlsBoot(IAppContext, Button, Button) for use native Bootstrap layouts.
(Inherited from DivWidgetBase.)
Protected methodRender
Render the scanner widget.
(Overrides DivWidgetBaseRender(IAppContext).)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodWriteResponse
Write the widget content and widget usage information to the response object in JSON format.
(Inherited from DivWidgetBase.)
Top
Fields
  NameDescription
Protected field_appCxt
The current IAppContext object initialized in the constructor.
(Inherited from DivWidgetBase.)
Protected field_httpCxt
The current HttpContext object initialized in the constructor.
(Inherited from DivWidgetBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also