Class Checkbox

Checkbox UI element.

Inheritance

Object

CallbackEventHandler

Focusable

VisualElement

Checkbox

Inherited Members

VisualElement.disabledUssClassName

UnityEngine.UIElements.VisualElement.ExecuteDefaultAction(UnityEngine.UIElements.EventBase)

UnityEngine.UIElements.VisualElement.Focus()

VisualElement.SendEvent(EventBase)

UnityEngine.UIElements.VisualElement.SetEnabledFromHierarchy(System.Boolean)

VisualElement.SetEnabled(Boolean)

VisualElement.MarkDirtyRepaint()

VisualElement.ContainsPoint(Vector2)

UnityEngine.UIElements.VisualElement.Overlaps(UnityEngine.Rect)

UnityEngine.UIElements.VisualElement.DoMeasure(System.Single, UnityEngine.UIElements.VisualElement.MeasureMode, System.Single, UnityEngine.UIElements.VisualElement.MeasureMode)

UnityEngine.UIElements.VisualElement.ToString()

VisualElement.GetClasses()

VisualElement.ClearClassList()

VisualElement.AddToClassList(String)

VisualElement.RemoveFromClassList(String)

VisualElement.ToggleInClassList(String)

VisualElement.EnableInClassList(String, Boolean)

VisualElement.ClassListContains(String)

VisualElement.FindAncestorUserData()

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Single, System.Single, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, System.Single>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Rect, UnityEngine.Rect, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Rect>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Color, UnityEngine.Color, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Color>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Vector3, UnityEngine.Vector3, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Vector3>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Vector2, UnityEngine.Vector2, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Vector2>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Quaternion, UnityEngine.Quaternion, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Quaternion>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.UIElements.Experimental.StyleValues, UnityEngine.UIElements.Experimental.StyleValues, System.Int32)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, System.Single>, System.Single, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, System.Single>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Rect>, UnityEngine.Rect, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Rect>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Color>, UnityEngine.Color, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Color>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Vector3>, UnityEngine.Vector3, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Vector3>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Vector2>, UnityEngine.Vector2, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Vector2>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Quaternion>, UnityEngine.Quaternion, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Quaternion>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.UIElements.Experimental.StyleValues, System.Int32)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Layout(UnityEngine.Rect, System.Int32)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.TopLeft(UnityEngine.Vector2, System.Int32)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Size(UnityEngine.Vector2, System.Int32)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Scale(System.Single, System.Int32)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Position(UnityEngine.Vector3, System.Int32)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Rotation(UnityEngine.Quaternion, System.Int32)

VisualElement.Add(VisualElement)

VisualElement.Insert(Int32, VisualElement)

VisualElement.Remove(VisualElement)

VisualElement.RemoveAt(Int32)

VisualElement.Clear()

VisualElement.ElementAt(Int32)

VisualElement.IndexOf(VisualElement)

VisualElement.Children()

UnityEngine.UIElements.VisualElement.Sort(System.Comparison<UnityEngine.UIElements.VisualElement>)

VisualElement.BringToFront()

VisualElement.SendToBack()

VisualElement.PlaceBehind(VisualElement)

VisualElement.PlaceInFront(VisualElement)

VisualElement.RemoveFromHierarchy()

UnityEngine.UIElements.VisualElement.GetFirstOfType<T>()

UnityEngine.UIElements.VisualElement.GetFirstAncestorOfType<T>()

VisualElement.Contains(VisualElement)

VisualElement.FindCommonAncestor(VisualElement)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IVisualElementScheduler.Execute(System.Action<UnityEngine.UIElements.TimerState>)

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IVisualElementScheduler.Execute(System.Action)

VisualElement.viewDataKey

VisualElement.userData

UnityEngine.UIElements.VisualElement.canGrabFocus

UnityEngine.UIElements.VisualElement.focusController

VisualElement.usageHints

VisualElement.transform

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.ITransform.position

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.ITransform.rotation

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.ITransform.scale

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.ITransform.matrix

VisualElement.layout

VisualElement.contentRect

VisualElement.paddingRect

VisualElement.worldBound

VisualElement.localBound

VisualElement.worldTransform

VisualElement.pickingMode

VisualElement.name

VisualElement.enabledInHierarchy

VisualElement.enabledSelf

VisualElement.visible

VisualElement.generateVisualContent

VisualElement.experimental

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IExperimentalFeatures.animation

VisualElement.hierarchy

UnityEngine.UIElements.VisualElement.cacheAsBitmap

VisualElement.parent

VisualElement.panel

VisualElement.contentContainer

VisualElement.visualTreeAssetSource

UnityEngine.UIElements.VisualElement.Item[System.Int32]

VisualElement.childCount

VisualElement.schedule

VisualElement.style

VisualElement.customStyle

VisualElement.styleSheets

VisualElement.tooltip

VisualElement.resolvedStyle

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.alignContent

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.alignItems

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.alignSelf

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.backgroundColor

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.backgroundImage

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderBottomColor

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderBottomLeftRadius

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderBottomRightRadius

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderBottomWidth

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderLeftColor

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderLeftWidth

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderRightColor

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderRightWidth

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderTopColor

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderTopLeftRadius

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderTopRightRadius

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderTopWidth

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.bottom

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.color

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.display

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexBasis

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexDirection

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexGrow

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexShrink

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexWrap

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.fontSize

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.height

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.justifyContent

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.left

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.letterSpacing

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.marginBottom

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.marginLeft

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.marginRight

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.marginTop

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.maxHeight

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.maxWidth

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.minHeight

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.minWidth

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.opacity

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.paddingBottom

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.paddingLeft

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.paddingRight

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.paddingTop

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.position

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.right

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.rotate

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.scale

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.textOverflow

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.top

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transformOrigin

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transitionDelay

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transitionDuration

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transitionProperty

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transitionTimingFunction

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.translate

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityBackgroundImageTintColor

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityBackgroundScaleMode

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityFont

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityFontDefinition

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityFontStyleAndWeight

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityParagraphSpacing

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unitySliceBottom

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unitySliceLeft

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unitySliceRight

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unitySliceTop

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityTextAlign

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityTextOutlineColor

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityTextOutlineWidth

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityTextOverflowPosition

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.visibility

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.whiteSpace

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.width

UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.wordSpacing

Focusable.Blur()

Focusable.focusable

Focusable.tabIndex

Focusable.delegatesFocus

UnityEngine.UIElements.CallbackEventHandler.RegisterCallback<TEventType>(UnityEngine.UIElements.EventCallback<TEventType>, UnityEngine.UIElements.TrickleDown)

UnityEngine.UIElements.CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(UnityEngine.UIElements.EventCallback<TEventType, TUserArgsType>, TUserArgsType, UnityEngine.UIElements.TrickleDown)

UnityEngine.UIElements.CallbackEventHandler.UnregisterCallback<TEventType>(UnityEngine.UIElements.EventCallback<TEventType>, UnityEngine.UIElements.TrickleDown)

UnityEngine.UIElements.CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(UnityEngine.UIElements.EventCallback<TEventType, TUserArgsType>, UnityEngine.UIElements.TrickleDown)

CallbackEventHandler.HandleEvent(EventBase)

CallbackEventHandler.HasTrickleDownHandlers()

CallbackEventHandler.HasBubbleUpHandlers()

CallbackEventHandler.ExecuteDefaultActionAtTarget(EventBase)

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.AppUI.UI

Syntax

public class Checkbox : VisualElement, IEventHandler, IStylePropertyAnimations, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IValidatableElement<CheckboxState>, INotifyValueChanged<CheckboxState>, ISizeableElement, IPressable

Constructors

Checkbox()

Default constructor.

Declaration

public Checkbox()

Fields

boxUssClassName

The Checkbox box styling class.

Declaration

public static readonly string boxUssClassName

Field Value

Type	Description
String

checkmarkUssClassName

The Checkbox checkmark styling class.

Declaration

public static readonly string checkmarkUssClassName

Field Value

Type	Description
String

emphasizedUssClassName

The Checkbox emphasized mode styling class.

Declaration

public static readonly string emphasizedUssClassName

Field Value

Type	Description
String

labelUssClassName

The Checkbox label styling class.

Declaration

public static readonly string labelUssClassName

Field Value

Type	Description
String

partialCheckmarkUssClassName

The Checkbox partial checkmark styling class.

Declaration

public static readonly string partialCheckmarkUssClassName

Field Value

Type	Description
String

sizeUssClassName

The Checkbox size styling class.

Declaration

public static readonly string sizeUssClassName

Field Value

Type	Description
String

ussClassName

The Checkbox main styling class.

Declaration

public static readonly string ussClassName

Field Value

Type	Description
String

Properties

clickable

Clickable Manipulator for this Checkbox.

Declaration

public Pressable clickable { get; set; }

Property Value

Type	Description
Pressable

Implements

IPressable.clickable

emphasized

The Checkbox emphasized mode.

Declaration

public bool emphasized { get; set; }

Property Value

Type	Description
Boolean

invalid

The Checkbox invalid state.

Declaration

public bool invalid { get; set; }

Property Value

Type	Description
Boolean

Implements

IValidatableElement<TValueType>.invalid

label

The text displayed in the Checkbox label.

Declaration

public string label { get; set; }

Property Value

Type	Description
String

size

The Checkbox size.

Declaration

public Size size { get; set; }

Property Value

Type	Description
Size

Implements

ISizeableElement.size

validateValue

The Checkbox validation function.

Declaration

public Func<CheckboxState, bool> validateValue { get; set; }

Property Value

Type	Description
Func<CheckboxState, Boolean>

Implements

IValidatableElement<TValueType>.validateValue

value

The Checkbox value.

Declaration

public CheckboxState value { get; set; }

Property Value

Type	Description
CheckboxState

Implements

UnityEngine.UIElements.INotifyValueChanged<T>.value

Methods

SetValueWithoutNotify(CheckboxState)

Set the Checkbox value without notifying the change.

Declaration

public void SetValueWithoutNotify(CheckboxState newValue)

Parameters

Type	Name	Description
CheckboxState	newValue	The new Checkbox value.

Implements

UnityEngine.UIElements.INotifyValueChanged<T>.SetValueWithoutNotify(T)

Extension Methods

VisualElementExtensions.FindNavController(VisualElement)

VisualElementExtensions.GetContext(VisualElement)

VisualElementExtensions.GetChildren<T>(VisualElement, Boolean)

VisualElementExtensions.GetPreferredTooltipPlacement(VisualElement)

VisualElementExtensions.SetPreferredTooltipPlacement(VisualElement, PopoverPlacement)

VisualElementExtensions.GetTooltipTemplate(VisualElement)

VisualElementExtensions.SetTooltipTemplate(VisualElement, VisualElement)

VisualElementExtensions.GetWorldBoundingBox(VisualElement)

VisualElementExtensions.GetContextProvider<T>(VisualElement)

VisualElementExtensions.GetContext<T>(VisualElement)

VisualElementExtensions.GetSelfContext<T>(VisualElement)

VisualElementExtensions.ProvideContext<T>(VisualElement, T)

VisualElementExtensions.IsContextProvider<T>(VisualElement)

VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)