PFDataWidgetTSettings Class |
Provides a base set of features for widgets consuming items from user-customizable
Application, ContentType and View.
Inheritance HierarchySystemObject
Packflow.Core.WidgetsPFWidgetBase
Packflow.Core.WidgetsPFWidgetBaseTSettings
Packflow.Core.Widgets.BuiltInPFDataWidgetTSettings
Packflow.Core.Widgets.BuiltInPFCounter
Packflow.Core.Widgets.BuiltInPFListView
Packflow.Core.WidgetsPFWidgetBase
Packflow.Core.WidgetsPFWidgetBaseTSettings
Packflow.Core.Widgets.BuiltInPFDataWidgetTSettings
Packflow.Core.Widgets.BuiltInPFCounter
Packflow.Core.Widgets.BuiltInPFListView
Namespace: Packflow.Core.Widgets.BuiltIn
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
SyntaxC#
public abstract class PFDataWidget<TSettings> : PFWidgetBase<TSettings> where TSettings : PFDataWidgetSettings
Type Parameters
- TSettings
The PFDataWidgetTSettings type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFDataWidgetTSettings |
Properties| Name | Description | |
|---|---|---|
 | Id |
Gets or set the unique id of this widget instance.
(Inherited from PFWidgetBase.) |
| Settings |
Gets the settings of this widget.
(Inherited from PFWidgetBaseTSettings.) |
Methods| Name | Description | |
|---|---|---|
 | GetApplicationCandidates |
Returns all possible applications that a user can select given the current settings.
|
| GetContentTypeCandidates |
Returns all possible content-types that a user can select given the current settings.
|
| GetFieldCandidates |
Returns all fields that a user can select given the current settings.
|
| GetSelectedApplication |
Returns the selected application, or null if no application is selected.
|
| GetSelectedContentType |
Returns the selected content-type, or null if no content-type is selected.
|
| GetSelectedContentTypeFields |
Returns the selected content-type fields, or null if no content-type is selected.
|
| GetSelectedField |
Returns the selected field for the given setting, or null no field is selected.
|
| GetSelectedView |
Returns the selected view, or null if no view is selected.
|
| GetSettings |
Returns a JSON representation of this widget settings that later be loaded using LoadSettings(JObject, JsonSerializer) (Inherited from PFWidgetBaseTSettings.) |
| GetValidationResult |
Validates the current widget.
(Inherited from PFWidgetBase.) |
| GetViewCandidates |
Returns all possible views that a user can select given the current settings.
|
| InitFromJson |
Init this widget using its id and its serialized JSON settings.
(Inherited from PFWidgetBase.) |
| LoadSettings |
Loads JSON-serialized settings into this widget.
(Inherited from PFWidgetBaseTSettings.) |
| RegisterFieldSetting |
Register a new field setting.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToWidgetData |
Returns a serializable PFWidgetData instance representing this widget.
(Inherited from PFWidgetBase.) |
| Validate |
Validates the current widget.
(Overrides PFWidgetBaseValidate(PFSite, PFWidgetValidationResult).) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) |
| EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) |
| GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) |
| IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) |
| Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
See Also