Window

Used to align the view relative to the layout parent region it resides in.

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.

Can be used to adjust the alpha color of this view and all its children. E.g. used for fade in/out animations. Is separate from and different from the background color of the view as it affects the children as well.

Background color of the view.

The sprite that will be rendered.

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

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

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

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

Indicates what type of fill method should be used.

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

Indicates if the background image graphic is to be maskable.

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

Indicates whether this image should preserve its Sprite aspect ratio.

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

Background image material.

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.

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

Indicates the types of objects that should block the raycasts.

Enum Values

Name	Description
None
TwoD
ThreeD
All

An enum indiciating how the close button should adjust its size to the label text.

Enum Values

Name	Description
None	Neither width nor height should be adjusted to text.
Width	Adjust width to text.
Height	Adjust height to text.
WidthAndHeight	Adjust width and height to text.

Specifies the alignment of the close button.

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.

The color of the close button image.

The font of the close button label.

The font color of the close button label.

The font size of the close button label.

The font style of the close button label.

Enum Values

Name	Description
Normal
Bold
Italic
BoldAndItalic

Specifies the height of the close button either in pixels or percents.

The sprite that will be rendered as the close button.

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

Enum Values

Name	Description
Simple
Sliced
Tiled
Filled

Boolean indicating if window button is active (visible and updated).

The line spacing of the close button label.

Specifies the margin of the close button.

The material of the close button image.

Specifies the offset of the close button.

The outline color of the close button label.

The distance of the close button label outline.

The shadow color of the close button label.

The distance of the close button label shadow.

Boolean indicating if the close button label supports rich text.

The text of the close button label.

The alignment of the text inside the close button 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.

The margin of the close button label. Can be used to adjust the text positioning.

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

The close button TextPadding is used when AdjustToText is set. It determines the additional padding to be added to the size of the button when it adjusts to the text.

Specifies the width of the close button either in pixels or percents.

Specifies the alignment of the content region.

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.

The color of the content region image.

Specifies the height of the content region image either in pixels or percents.

The sprite that will be rendered as the content region.

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

Enum Values

Name	Description
Simple
Sliced
Tiled
Filled

Specifies the offset of the content region image.

The material of the content region image.

Specifies the offset of the content region image.

Specifies the width of the content region image either in pixels or percents.

Pixels per unit to use for dynamically generated bitmaps such as text.

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

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

Enum Values

Name	Description
None
HideInHierarchy
HideInInspector
DontSaveInEditor
NotEditable
DontSaveInBuild
DontUnloadUnusedAsset
DontSave
HideAndDontSave

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.

Tells the graphic raycaster to ignore graphical components facing away from the camera.

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.

Boolean indicating if the window can be moved by clicking and dragging the title region.

Boolean indicating if the window is opened.

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

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.

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.

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.

Scale the canvas area with the width as reference (0), the height as reference (1), or something in between (e.g. 0.75).

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

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

Canvas draw order within a sorting layer.

Boolean indicating if the default behavior on close button click should be overridden.

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

Boolean indicating if the pixel perfect setting should be overriden (not inherited from parent canvas).

Boolean indicating if the sort order should be overriden (not inherited from parent canvas).

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

The normalized position that the view rect transform rotates around.

Indicates if the canvas is to be aligned with pixels. Only applied if render mode is set to ScreenSpace.

The plane distance determines how far away from the camera the canvas is generated.

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

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

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.

If a sprite has 'Pixels Per Unit' setting, one pixel in the sprite will cover one unit in the UI.

The resolution the UI layout is designed for. If the screen resolution is larger, the UI will be scaled up, and if it’s smaller, the UI will be scaled down.

Camera used for sizing the canvas when in render mode set to: Screen Space - Camera. Also used as camera that events will be sent through in world space.

Specifies the render mode to be used by the canvas.

Enum Values

Name	Description
ScreenSpaceOverlay
ScreenSpaceCamera
WorldSpace

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.

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

Scales all children within the canvas by this factor.

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

Unique ID of the canvas sorting layer.

Name of the canvas sorting layer.

Canvas draw order within a sorting layer.

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.

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).

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.

The text of the window title.

An enum indiciating how the title should adjust its size to the label text.

Enum Values

Name	Description
None	Neither width nor height should be adjusted to text.
Width	Adjust width to text.
Height	Adjust height to text.
WidthAndHeight	Adjust width and height to text.

The alignment of the window text label.

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.

The font of the window title.

The font color of the window title.

The font size of the window title.

The font style of the window title.

Enum Values

Name	Description
Normal
Bold
Italic
BoldAndItalic

The line spacing of the window title.

The margin of the window title. Can be used to adjust the text positioning.

The offset of the window title. Can be used with TextMargin and TextAlignment to get desired positioning of the text.

The outline color of the window title.

The distance of the window title outline.

Specifies the alignment of the title region.

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.

The color of the title region image.

Specifies the height of the title region image either in pixels or percents.

The sprite that will be rendered as the title region.

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

Enum Values

Name	Description
Simple
Sliced
Tiled
Filled

Specifies the offset of the title region image.

The material of the title region image.

Specifies the offset of the title region image.

Specifies the width of the title region image either in pixels or percents.

The shadow color of the window title.

The distance of the window title shadow.

Boolean indicating if the window title supports rich text.

The alignment of the text inside the window title. 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.

Determines how the children within the canvas are scaled.

Enum Values

Name	Description
ConstantPixelSize
ScaleWithScreenSize
ConstantPhysicalSize

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.

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

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

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

The color of the window region image.

The sprite that will be rendered as the window region.

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

Enum Values

Name	Description
Simple
Sliced
Tiled
Filled

The material of the window region image.

Specifies the alignment of the window region.

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.

Specifies the height of the window region image either in pixels or percents.

Specifies the offset of the window region image.

Specifies the offset of the window region image.

Specifies the width of the window region image either in pixels or percents.