Click or drag to resize

OptionalElementWidget Class

Base class for classes used to return JSON response to a request for an optional element widget.
Inheritance Hierarchy

Namespace:  NetQuarry
Assembly:  EAP.WebMappers (in EAP.WebMappers.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public abstract class OptionalElementWidget

The OptionalElementWidget type exposes the following members.

Constructors
  NameDescription
Protected methodOptionalElementWidget
Initializes a new instance of the OptionalElementWidget class
Top
Properties
  NameDescription
Protected propertyAppContext
The application context.
Protected propertyCaption
The localized caption to use for the widget.
Protected propertyHint
The localized widget use hint to provide.
Protected propertyMOP
The MOP of the requesting page.
Protected propertyPageElement
The page element for the request. Non-null only when the request is element-specific.
Protected propertyPageInfo
The page info for the current page.
Protected propertyPopupName
The unique name of the popup. Currently this is used to provide a unique CSS class for the popup widget.
Protected propertyPreferenceName
The name under which this user's show/hide preference is stored.
Protected propertyPrefNameBase
Gets the base name for user preferences that originally were stored by MOP, but now need to be stored by MOP:PageElementName when inter-pane navigation is in use (any maybe at other times, so we do it now based on whether or not hosted in a ConsoleTemplate).
Protected propertyRequest
The current request HTTP. Typically used only if additional query parameter values are required by the widget.
Protected propertyRequiresPageElement
Gets whether or not this widget requires a PageElementInfo. Items requiring a page element operate on a particular page element rather than on the page as a whole.
Protected propertyUseBootstrap
Gets whether or not Bootstrap is being used.
Top
Methods
  NameDescription
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 methodGetItems
Gets the list of optional elements for the widget.
Protected methodGetText
Helper method for obtaining localized strings from the resource file.
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.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodWriteResponse
Writes the JSON resonse to the HTTP response.
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