Interface ICheckboxComponent

The checkbox component allows having an entity behave like a checkbox (can be checked an unchecked).

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

[RequiredComponent(typeof(IUIEvents), true)]
[RequiredComponent(typeof(IAnimationComponent), true)]
[RequiredComponent(typeof(ITextComponent), false)]
[RequiredComponent(typeof(IImageComponent), false)]
[RequiredComponent(typeof(IBorderComponent), false)]
public interface ICheckboxComponent : IComponent, IDisposable, INotifyPropertyChanged

Properties

| Improve this Doc View Source

Checked

Gets or sets a value indicating whether this ICheckboxComponent is checked.

Declaration

bool Checked { get; set; }

Property Value

Type	Description
System.Boolean	`true` if checked; otherwise, `false`.

| Improve this Doc View Source

CheckedAnimation

Gets or sets the animation when the checkbox is checked.

Declaration

ButtonAnimation CheckedAnimation { get; set; }

Property Value

Type	Description
ButtonAnimation	The checked animation.

| Improve this Doc View Source

HoverCheckedAnimation

Gets or sets the animation when the checkbox is checked and the mouse is hovering over it.

Declaration

ButtonAnimation HoverCheckedAnimation { get; set; }

Property Value

Type	Description
ButtonAnimation	The hover checked animation.

| Improve this Doc View Source

HoverNotCheckedAnimation

Gets or sets the animation when the checkbox is not checked and the mouse is hovering over it.

Declaration

ButtonAnimation HoverNotCheckedAnimation { get; set; }

Property Value

Type	Description
ButtonAnimation	The hover not checked animation.

| Improve this Doc View Source

NotCheckedAnimation

Gets or sets the animation when the checkbox is not checked.

Declaration

ButtonAnimation NotCheckedAnimation { get; set; }

Property Value

Type	Description
ButtonAnimation	The not checked animation.

| Improve this Doc View Source

OnCheckChanged

An event which is triggered whenever the check state changes.

Declaration

IBlockingEvent<CheckBoxEventArgs> OnCheckChanged { get; }

Property Value

Type	Description
IBlockingEvent<CheckBoxEventArgs>	The event.

| Improve this Doc View Source

RadioGroup

Allows setting a radio group, which can be used to group multiple checkboxes together to guarantee that only a single checkbox is checked at any given time.

Declaration

IRadioGroup RadioGroup { get; set; }

Property Value

Type	Description
IRadioGroup	The radio group.

| Improve this Doc View Source

TextLabel

An optional text label to accompany the checkbox.

Declaration

ILabel TextLabel { get; set; }

Property Value

Type	Description
ILabel	The text label.