PFWidget_QuickAccess Class |
Widget allowing the user to search for items with a single text box.
You must include the resources using ResourcesHtml.GetWidgetResources_QuickAccess in the head of your page.
Inheritance HierarchyNamespace: Packflow.Interface
Assembly: MicaSystems.Packflow.Interface (in MicaSystems.Packflow.Interface.dll) Version: 1.0.0.0 (2.0.0.223)
SyntaxC#
public class PFWidget_QuickAccess : PFWidget
The PFWidget_QuickAccess type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFWidget_QuickAccess |
Initializes a new instance of the PFWidget_QuickAccess class.
|
Properties| Name | Description | |
|---|---|---|
 | ActionMenu |
Gets or sets the content of the action menu, available for each result.
|
| BottomButtons |
Gets or sets the list of
buttons to show in the bottom part of the widget. Important : currently not persisted across SignalR!
|
| ContentTypeDisplayMode |
Gets or sets a value describing how the content-type of found items is displayed.
|
| ContentTypes |
Gets or sets the target content-types.
|
| CreationContentType |
Gets or sets the default content-type used for item creation.
(Inherited from PFWidget.) |
| DisplayedFieldName |
Gets or sets the name of the field used to represent each found item.
|
| FilteringFieldNames |
Gets or sets the list of filtered fields.
If a field is not found in any target content-types, an exception is thrown. If a field is found in some target content-types, it will obviously only be applied when its possible. |
| Height |
Gets or sets the height.
(Inherited from PFWidget.)Default value: 100%. |
| HeighthResizable |
Gets or sets a value indicating whether the widget is vertically resizable.
(Inherited from PFWidget.) |
| HighlightFilter |
Gets or sets a value indicating whether the found keyword must be highlighted in results.
Default value: True. |
| HtmlClass |
Gets the additional HTML classes.
(Overrides PFWidgetHtmlClass.) |
| HtmlId |
Gets or sets the HTML identifier.
(Inherited from PFWidget.) |
| IgnoreAccents |
Gets or sets a value indicating whether filters should ignore accents or not.
Note : this only applies when the database is currently NOT ignoring accents by default. Attention, this can greatly degrade performances! |
 | Logger |
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFWidget.) |
| Query | Gets or sets the query used to filter elements displayed in the quick access area. Some restrictions will be applied : -results limit cannot exceed 50 -groups and aggregations will be disabled -field mode will be set to Custom |
| Site |
Gets the contextual Packflow Site.
(Inherited from PFWidget.) |
| SourceUrl |
Gets the source URL.
(Inherited from PFWidget.) |
| TitleContent |
Gets or sets the html content of the title.
(Inherited from PFWidget.) |
| TopButtons |
Gets or sets the list of
buttons to show in the top part of the widget. Important : currently not persisted across SignalR!
|
| Translations |
Gets the contextual translations provided by Packflow.
(Inherited from PFWidget.) |
| Width |
Gets or sets the width.
(Inherited from PFWidget.)Default value: 50%. |
| WidthResizable |
Gets or sets a value indicating whether the widget is horizontally resizable.
(Inherited from PFWidget.) |
Methods| Name | Description | |
|---|---|---|
 | GenerateContentHtml |
Generates the content HTML, which will take place in the generic placeholder.
(Overrides PFWidgetGenerateContentHtml.) |
| GeneratePlaceHolderHtml |
Generates the widget's HTML.
(Inherited from PFWidget.) |
| GenerateValuesHtml |
Retrieves filtered results from the database and generates the corresponding HTML.
|
| GetSettingHtml |
Appends the widget's setting to the specified builder, in HTML format.
(Inherited from PFWidget.) |
| GetSettingsHtml |
Appends the settings in the builder, in a HTML format.
The use of the method "GetSettingHtml" is recommended.
(Overrides PFWidgetGetSettingsHtml(HtmlBuilder).) |
| LoadSettingsFromHtml |
Loads the settings from HTML values.
Example: this.SourceUrl = data.TryGetValue("SourceUrl")
(Overrides PFWidgetLoadSettingsFromHtml(DictionaryString, String).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Validate |
Validates the settings.
(Overrides PFWidgetValidate.) |
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