Class CountWidgetBase

Namespace

Dynamicweb.Dashboard.Widgets

Assembly

Dynamicweb.Core.dll

The class CountWidget provides base counter dashboard widget

public abstract class CountWidgetBase : DashboardWidget, IParameterOptions

Inheritance

object

ConfigurableAddIn

DashboardWidget

CountWidgetBase

Implements

IParameterOptions

Derived

ThresholdCountWidget

Inherited Members

DashboardWidget.Id

DashboardWidget.CreatedDate

DashboardWidget.ModifiedDate

DashboardWidget.Columns

DashboardWidget.Title

DashboardWidget.ShowTitle

DashboardWidget.Order

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

using Dynamicweb.Dashboard.Widgets;
using Dynamicweb.Extensibility.AddIns;
using System.Diagnostics;

namespace Dynamicweb.Dashboard.Examples;

[AddInName("Application memory usage")]
[AddInDescription("Show current process memory usage information")]
[AddInIcon(Core.UI.Icons.KnownIcon.Dehaze)]
public sealed class MemoryUsageCounter : CountWidgetBase
{
    public MemoryUsageCounter()
    {
        Title = "Memory usage";
        Columns = 2;
    }

    public override string GetCounterNumber()
    {
        Process currentProcess = Process.GetCurrentProcess();
        long totalBytesOfMemoryUsed = currentProcess.WorkingSet64;
        Helper.HumanizeByteSize(totalBytesOfMemoryUsed, out double count, out string subtitle);
        Subtitle = subtitle;

        return string.Format("{0:0.##}", count);
    }
}

Constructors

CountWidgetBase()

The counter widget default constructor

public CountWidgetBase()

Properties

BackgroundColor

Gets or sets counter background color

public WidgetColor BackgroundColor { get; set; }

Property Value

WidgetColor

DefaultBackgroundColor

Gets or sets counter default background color

[AddInLabel("Color")]
[AddInParameter("ColorParameterEditor")]
[AddInParameterEditor(typeof(DropDownParameterEditor), "")]
public virtual WidgetColor DefaultBackgroundColor { get; set; }

Property Value

WidgetColor

Subtitle

Gets or sets counter sub title

public virtual string Subtitle { get; set; }

Property Value

string

Methods

GetCounterNumber()

Gets or sets counter number

public abstract string GetCounterNumber()

Returns

string

GetParameterOptions(string)

Gets parameteroptions

public override IEnumerable<ParameterOption> GetParameterOptions(string parameterName)

Parameters

parameterName string

Returns

IEnumerable<ParameterOption>