InputField

Background color of the view.

BackgroundImage

SpriteAsset

Background image sprite.

The sprite that will be rendered.

BackgroundImageEventAlphaThreshold

float

Alpha threshold for letting through events.

The alpha threshold specifying the minimum alpha a pixel must have for the event to be passed through.

BackgroundImageFillAmount

float

Background image fill amount.

Amount of the Image shown when the Image.type is set to Image.Type.Filled.

BackgroundImageFillCenter

bool

Indicates if center should be filled.

Boolean indicating whether or not to render the center of a Tiled or Sliced image.

BackgroundImageFillClockwise

bool

Indicates if the image should be filled clockwise.

Whether the Image should be filled clockwise (true) or counter-clockwise (false).

BackgroundImageFillMethod

FillMethod

Background image fill method.

Indicates what type of fill method should be used.

Enum Values

Name	Description
Horizontal
Vertical
Radial90
Radial180
Radial360

BackgroundImageFillOrigin

int

Background image fill origin.

Controls the origin point of the Fill process. Value means different things with each fill method.

BackgroundImageMaskable

bool

Indicates if the image is maskable.

Indicates if the background image graphic is to be maskable.

BackgroundImageOverrideSprite

SpriteAsset

Background image override sprite.

Set an override sprite to be used for rendering. If set the override sprite is used instead of the regular image sprite.

BackgroundImagePreserveAspect

bool

Preserve aspect ratio.

Indicates whether this image should preserve its Sprite aspect ratio.

BackgroundImageType

Type

Type of background image.

The type of the image sprite that is to be rendered.

Enum Values

Name	Description
Simple
Sliced
Tiled
Filled

BackgroundMaterial

Material

Background image material.

BaseDirectory

string

Base directory.

Specifies the base directory to be used by the view and its children. The base directory is used when loading resources such as sprites, fonts, etc.

BasedOn

string

Based on style.

Used in style definition to specify which style it's based on.

CaretBlinkRate

float

Caret blinks per second.

The blinking rate of the input caret, defined as the number of times the blink cycle occurs per second.

CaretColor

Caret color.

The custom caret color used if customCaretColor is set.

CaretPosition

int

Current caret position.

Current InputField caret position (also selection tail).

CaretWidth

int

Caret width.

The width of the caret in pixels.

CharacterLimit

int

Character limit.

How many characters the input field is limited to. 0 = infinite.

CharacterValidation

Character input validation.

The type of validation to perform on the input.

Enum Values

Name	Description
None
Integer
Decimal
Alphanumeric
Name
EmailAddress

ContentType

Type of input content (standard, password, etc).

Type of input field content.

Enum Values

Name	Description
Standard
Autocorrected
IntegerNumber
DecimalNumber
Alphanumeric
Name
EmailAddress
Password
Pin
Custom

Font

Input field text font.

The font of the input field label.

FontColor

Input field text font color.

The font color of the input field label.

FontSize

int

Input field text font size.

The font size of the input field label.

FontStyle

Input field text font style.

The font style of the input field label.

Enum Values

Name	Description
Normal
Bold
Italic
BoldAndItalic

Height

The height of the view.

Specifies the height of the view either in pixels or percents.

HideFlags

Hide flags for the game object.

Bit mask that controls object destruction, saving and visibility in editor.

Enum Values

Name	Description
None
HideInHierarchy
HideInInspector
DontSaveInEditor
NotEditable
DontSaveInBuild
DontUnloadUnusedAsset
DontSave
HideAndDontSave

string

The ID of the view.

Specifies a unique ID for the view. Used to map the view to reference fields on the parent view model. Provides a way to reference the view in data bindings. Is used as selectors in styles.

InputType

Type of input expected.

Enum indicating what type of input is expected.

Enum Values

Name	Description
Standard
AutoCorrect
Password

IsActive

bool

Indicates if the view is enabled.

Activates/deactivates the view. If set to false in this or in any parent view, all components are disabled, attached renderers are turned off, etc. Any components attached will no longer have Update() called.

IsDestroyed

bool

Indicates if the view has been destroyed by GameObject.Destroy().

IsDynamic

bool

Indicates if the view has been created dynamically.

IsInitialized

bool

Gets or sets bool indicating if the view has been initialized.

IsReadOnly

bool

Indicates if input field is read-only.

Boolean indicating if input field is read-only.

IsTemplate

bool

Indicates if this view is to be used as a template.

A template view is used to create dynamic instances of the view. Used by certain views such as the List and TabPanel.

IsVisible

bool

Indicate if the view is visible.

Can be used to adjust the visiblity of the view. If set to false the view is made invisible but unlike when deactivating the view, invisible views are still is active and takes up space.

Item

object

Item data.

Provides a mechanism to bind to dynamic list data. The item is set, e.g. by the List view on the child views it generates for its dynamic list data. The Item points to the list item data the view is associated with.

KeyboardType

TouchScreenKeyboardType

Type of touch screen keyboard.

The type of touch screen keyboard that will be used.

Enum Values

Name	Description
Default
ASCIICapable
NumbersAndPunctuation
URL
NumberPad
PhonePad
NamePhonePad
EmailAddress
NintendoNetworkAccount

LayoutRoot

UserInterface

Gets layout root canvas.

LineSpacing

float

Input field text line spacing.

The line spacing of the input field label.

LineType

Input field line type.

Enum indicating line type of the input field.

Enum Values

Name	Description
SingleLine
MultiLineSubmit
MultiLineNewline

Margin

View margin

Determines the size of the content region relative the view's width and height. Adding margins to a view does not change its width or height.

Offset

View offset.

Determines the offset of the content region relative to the view's position.

OffsetFromParent

View offset from parent.

Used by parent views to adjust the positioning of its children without affecting the internal offset of the children.

OnlyTriggerValueChangedFromUI

bool

Indicates that the value changed action is only to be triggered from changes made to the text in the UI.

OutlineColor

Input field text outline color.

The outline color of the input field label.

OutlineDistance

Vector2

Input field text outline distance.

The distance of the input field label outline.

OverrideHeight

Override height.

Used to override the layouting logic of inherited views and set the specified height.

OverrideWidth

Override width.

Used to override the layouting logic of inherited views and set the specified width.

Pivot

Vector2

View pivot position.

The normalized position that the view rect transform rotates around.

Position

Vector3

Position of the view.

The local position of the view in relation to the layout parent view transform.

PropagateChildLayoutChanges

bool

Indicates if the view propagates child layout changes.

Boolean indicating if view propagates child layout changes. Generally set to true whenever a view adjusts its size to child layout changes.

RaycastBlockMode

Indicates when raycast should be blocked.

Enum indicating when raycasts should be blocked by the view.

Enum Values

Name	Description
Default	Raycast is blocked if view is displayed and not transparent.
Always	Raycast is always blocked.
Never	Raycast is never blocked.

Rotation

Quaternion

Rotation of the view.

The local rotation of the view in relation to the layout parent view transform. Stored as a Quaternion but specified in XUML as euler angles.

Scale

Vector3

Scale of the view.

The scale of the view in relation to the layout parent view transform.

SelectionColor

Selection color.

The color of the highlight showing which characters are selected.

SelectionEnd

int

Selection end position.

SelectionStart

int

Selection start position.

SetValueOnEndEdit

bool

Indicates if text value should be updated at end edit.

Boolean indicating if text value should be set at end edit rather than while text is being typed.

ShadowColor

Input field text shadow color.

The shadow color of the input field label.

ShadowDistance

Vector2

Input field text shadow distance.

The distance of the input field label shadow.

ShouldHideMobileInput

bool

Indicates if mobile input should be hidden.

Boolean indicating if mobile input should be hidden.

SortIndex

int

View sort index.

The sort index is used by views such as Group and List to sort its child views.

State

string

View state.

View state name. Determines state values to be applied to the view. All views start out in the "Default" state and when the state changes the values associated with that state are applied to the view.

Style

string

The style of the view.

Used as selector by the styles. Specifies the name of the style that is to be applied to the view and any children that explicitly inherits its style. The style is applied when the view is created (usually in the editor as the XUML is processed).

SupportRichText

bool

Supports rich text.

Boolean indicating if the input field label supports rich text.

Text

string

Input field text.

Text displayind in the input field. Set as text is typed or at the end of edit if SetValueOnEndEdit is set.

TextAlignment

ElementAlignment

Input field text alignment.

The alignment of the text inside the input field label. Can be used with TextMargin and TextOffset to get desired positioning of the text.

Enum Values

Name	Description
Center	Element centered horizontally and vertically.
Left	Element aligned to the left horizontally and centered vertically.
Top	Element aligned to the top vertically and centered horizontally.
Right	Element aligned to the right horizontally and centered vertically.
Bottom	Element aligned to the bottom vertically and centered horizontally.
TopLeft	Element aligned to the top vertically and to the left horizontally.
TopRight	Element aligned to the top vertically and to the right horizontally.
BottomLeft	Element aligned to the bottom vertically and to the left horizontally.
BottomRight	Alement aligned to the bottom vertically and to the right horizontally.

TextMargin

Input field text margin.

The margin of the input field label. Can be used to adjust the text positioning.

TextOffset

Input field text offset.

The offset of the input field label. Can be used with TextMargin and TextAlignment to get desired positioning of the text.

Theme

string

The theme of the view.

Specifies the name of the theme that is applied to the view and its children. The theme determines which set of styles are to be considered when applying matching styles to the view.

UnitSize

Vector3

Unit size.

Specifies the user-defined unit size to be used by the view and its children. Used when element size is specified in user-defined units to convert it into pixels.

UpdateBackground

bool

Indicates if background is updated.

If set to false the background image and color is not updated by the view. Is used when the background updates is done elsewhere.

UpdateRectTransform

bool

Indicates if rect transform is updated.

If set to false the rect transform is not updated by the layout logic. It is used when layouting is done elsewhere.

UseCustomCaretColor

bool

Indicates if custom caret color should be used.

Boolean indicating if the custom caret color specified by CaretColor should be used.

Width