Table of Contents

Class Widget

Namespace: Casewhere.Models.Pages.Widgets
Assembly: Casewhere.Models.dll

widgets can be reused in different pages

public abstract class Widget : Entity, IIdentity

Inheritance

objectEntityWidget

Derived

CustomWidget, GridWidget, ListWidget, TabContainerWidget, WorkflowContainerWidget

Implements

IIdentity

Inherited Members

Entity.GetResourceName(), Entity.Id, Entity.Version, Entity.CreatedBy, Entity.CreatedAt, Entity.ModifiedBy, Entity.ModifiedAt, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Extension Methods

ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<Widget>(Widget)

Constructors

Widget()

protected Widget()

Properties

AccessRule

Gets or sets the access rule for the widget.

public AccessRule AccessRule { get; set; }

Property Value

AccessRule

AccessibilitySettings

public AccessibilitySettings AccessibilitySettings { get; set; }

Property Value

AccessibilitySettings

Actions

Gets or sets the list of actions associated with the widget. Widget Actions will be rendered on the left top of the widget

public IList<WidgetAction> Actions { get; set; }

Property Value

IList<WidgetAction>

AutoHeightMode

public AutoHeightMode AutoHeightMode { get; set; }

Property Value

AutoHeightMode

Collapsible

Gets or sets a value indicating whether the widget is collapsible.

public bool Collapsible { get; set; }

Property Value

bool

DataSourceId

Gets or sets the data source ID of the widget. See Casewhere.Models.DataSource

public Guid DataSourceId { get; set; }

Property Value

Guid

EnableFiltering

Gets or sets a value indicating whether filtering is enabled for the widget. The Widget will show a filter bar on top of the widget.

public bool EnableFiltering { get; set; }

Property Value

bool

EnableFullTextSearch

Gets or sets a value indicating whether full text search is enabled for the widget. The Widget will show a search bar on top of the widget.

public bool EnableFullTextSearch { get; set; }

Property Value

bool

EnableInheritedSecurityRules

public bool EnableInheritedSecurityRules { get; set; }

Property Value

bool

EnableRefresh

Gets or sets a value indicating whether refresh is enabled for the widget. The Widget will show a refresh button on top of the widget.

public bool EnableRefresh { get; set; }

Property Value

bool

Height

Gets or sets the height of the widget.

public string Height { get; set; }

Property Value

string

IsLocked

public bool IsLocked { get; set; }

Property Value

bool

Modes

Gets or sets the list of modes for the widget.

public IList<string> Modes { get; set; }

Property Value

IList<string>

Name

Gets or sets the name of the widget.

public string Name { get; set; }

Property Value

string

ParallelDataLoading

public bool ParallelDataLoading { get; set; }

Property Value

bool

ProductId

Gets or sets the product ID of the widget.

public Guid ProductId { get; set; }

Property Value

Guid

ProjectFields

Gets or sets the list of project fields for the widget.

public IList<string> ProjectFields { get; set; }

Property Value

IList<string>

Query

Gets or sets the query for the widget data.

public WidgetDataQuery Query { get; set; }

Property Value

WidgetDataQuery

RequireCaseContext

Gets or sets a value indicating whether the widget requires case context.

public bool RequireCaseContext { get; set; }

Property Value

bool

Reusable

Gets or sets a value indicating whether the widget is reusable.

public bool Reusable { get; set; }

Property Value

bool

RowTemplate

Gets or sets the row template for the widget.

public string RowTemplate { get; set; }

Property Value

string

ShowInPanel

Gets or sets a value indicating whether the widget should be shown in a panel.

public bool ShowInPanel { get; set; }

Property Value

bool

Tags

public IList<string> Tags { get; set; }

Property Value

IList<string>

Title

Gets or sets the title of the widget.

public string Title { get; set; }

Property Value

string

Type

Gets the type of the widget.

public abstract string Type { get; }

Property Value

string

Methods

GetResourceName()

Gets the display name of the entity.

public override string GetResourceName()

Returns

string

The display name of the entity.