StateHasChangedConfig

Definition

Assembly: CloudNimble.BlazorEssentials.dll

Namespace: CloudNimble.BlazorEssentials

Inheritance: System.Object

Syntax

CloudNimble.BlazorEssentials.StateHasChangedConfig

Constructors

.ctor

Syntax

public StateHasChangedConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Action

Allows the current Blazor container to pass the StateHasChanged action back to the BlazorObservable so ViewModel operations can trigger state changes.

Syntax

public System.Action Action { get; set; }

Property Value

Type: System.Action

Remarks

Will optionally drop intermediate StateHasChanged calls in a rapidly-updating environment, based on StateHasChangedConfig.DelayMode and StateHasChangedConfig.DelayInterval.

BlazorObservableType

The BlazorObservableType associated with this Configuration instance.

Syntax

public System.Type BlazorObservableType { get; set; }

Property Value

Type: System.Type

Count

Syntax

public int Count { get; set; }

Property Value

Type: int

Remarks

This is public so

DebugMode

Flag for whether or not the render count and helpful debug feedback/warnings should be logged to the Console. Default is StateHasChangedDebugMode.Off.

Syntax

public CloudNimble.BlazorEssentials.StateHasChangedDebugMode DebugMode { get; set; }

Property Value

Type: CloudNimble.BlazorEssentials.StateHasChangedDebugMode

DelayInterval

An Int32 specifying the number of milliseconds this BlazorObservable should wait between StateHasChangedConfig.Action calls. Default is 100 milliseconds.

Syntax

public int DelayInterval { get; set; }

Property Value

Type: int

Remarks

StateHasChangedConfig.DelayMode must be set to StateHasChangedDelayMode.Debounce or StateHasChangedDelayMode.Throttle for this setting to take effect.

DelayMode

A StateHasChangedConfig.DelayMode indicating whether or not this BlazorObservable should reduce the number of times StateHasChangedConfig.Action should be called in a given StateHasChangedConfig.DelayInterval Default is StateHasChangedDelayMode.Off.

Syntax

public CloudNimble.BlazorEssentials.StateHasChangedDelayMode DelayMode { get; set; }

Property Value

Type: CloudNimble.BlazorEssentials.StateHasChangedDelayMode

Methods

Clone

Copies the values from this StateHasChangedConfig instance into a new one.

Syntax

public CloudNimble.BlazorEssentials.StateHasChangedConfig Clone(CloudNimble.BlazorEssentials.BlazorObservable observable)

Parameters

Name	Type	Description
observable	CloudNimble.BlazorEssentials.BlazorObservable	The BlazorObservable instance the new StateHasChangedConfig instance will be used for.

Returns

Type: CloudNimble.BlazorEssentials.StateHasChangedConfig A new StateHasChangedConfig instance with the values populated from this instance.

Remarks

This is required because if we used DI to inject a StateHasChangedConfig instance, we wouldn’t be able to have different configurations per ViewModelBase2`, AND we would end up overwriting the StateHasChangedConfig.ActionActions</see> from other Pages when the value was set.

Dispose

Syntax

public void Dispose()

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
obj	object?	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

Related APIs

• System.IDisposable