Interface INumberEditorComponent

A component that acts as a control to edit numbers.

Inherited Members

IComponent.Name

IComponent.Entity

IComponent.RegistrationType

IComponent.Init(IEntity, Type)

IComponent.AfterInit()

System.IDisposable.Dispose()

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface INumberEditorComponent : IComponent, IDisposable, INotifyPropertyChanged

Properties

| Improve this Doc View Source

DownButton

Gets or sets an optional button that will decrease the value by Step when clicked.

Declaration

IButton DownButton { get; set; }

Property Value

Type	Description
IButton	Up button.

| Improve this Doc View Source

EditWholeNumbersOnly

Gets or sets a value indicating whether this INumberEditorComponent edits whole numbers only (ints), or numbers with decimal digits (floats).

Declaration

bool EditWholeNumbersOnly { get; set; }

Property Value

Type	Description
System.Boolean	`true` if edit whole numbers only; otherwise, `false`.

| Improve this Doc View Source

MaxValue

Gets or sets the maximum allowed value.

Declaration

float? MaxValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>	The max value.

| Improve this Doc View Source

MinValue

Gets or sets the minimum allowed value.

Declaration

float? MinValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>	The minimum value.

| Improve this Doc View Source

OnValueChanged

An event which fires whenever the value is changed.

Declaration

IBlockingEvent<NumberValueChangedArgs> OnValueChanged { get; }

Property Value

Type	Description
IBlockingEvent<NumberValueChangedArgs>	The event.

| Improve this Doc View Source

Slider

Gets or sets an optional slider which will allow editing the value by sliding the handle. The range of the slider is determined by either SuggestedMinValue and SuggestedMaxValue if those exist, otherwise by MinValue and MaxValue if those exist, otherwise the arbitrary -1000 and 1000 are set as minimum and maximum.

Declaration

ISlider Slider { get; set; }

Property Value

Type	Description
ISlider	The slider.

| Improve this Doc View Source

Step

Gets or sets the step that increases/decreases the value when pressing on the up/down arrow keys/buttons.

Declaration

float Step { get; set; }

Property Value

Type	Description
System.Single	The step.

| Improve this Doc View Source

SuggestedMaxValue

Gets or sets the suggested maximum value. This will be the maximum value shown in the slider (if one exists), but will not be forced on a user which types a value by hand.

Declaration

float? SuggestedMaxValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>	The suggested maximum value.

| Improve this Doc View Source

SuggestedMinValue

Gets or sets the suggested minimum value. This will be the minimum value shown in the slider (if one exists), but will not be forced on a user which types a value by hand.

Declaration

float? SuggestedMinValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>	The suggested minimum value.

| Improve this Doc View Source

UpButton

Gets or sets an optional button that will increase the value by Step when clicked.

Declaration

IButton UpButton { get; set; }

Property Value

Type	Description
IButton	Up button.

| Improve this Doc View Source

Value

Gets or sets the edited number.

Declaration

float Value { get; set; }

Property Value

Type	Description
System.Single	The value.

Methods

| Improve this Doc View Source

SetUserInitiatedValue(Single)

Sets the value and have it marked as changed by the user.

Declaration

void SetUserInitiatedValue(float value)

Parameters

Type	Name	Description
System.Single	value	Value.