Class PageMetadata

Defines properties and message types for Page.

Inherits properties and message types from Node2DMetadata.

Property Types

See also PropertyType
PageMetadata.StateProperty

The state of this Page node: false (inactive and invisible) or true (active and visible) (read-only).

PageMetadata.SlideOffsetProperty

The offset to slide a Page node in horizontal or vertical direction:\nX [-1, 1] to move the Page node horizontally\nY [-1, 1] to move the Page node vertically

PageMetadata.ScaleOffsetProperty

The factor by which to scale a Page node.

PageMetadata.RotationOffsetProperty

The angle in degrees by which to rotate a Page node.

PageMetadata.AutoActivateProperty

Always activate this Page node when its parent is active.

PageMetadata.TransitionPhaseProperty

The phase of the transition. For example, use for pixel-based effects.

Message Types

See also MessageType
PageMetadata.NavigateMessage

Navigates to the specified page, sets it as active.

Arguments: PageMetadata.NavigateMessageArguments

PageMetadata.NavigateParentMessage

Navigates to the parent page.

Arguments: PageMetadata.NavigateParentMessageArguments

PageMetadata.ActivatedMessage

Page has been activated.

Arguments: PageMetadata.ActivatedMessageArguments

PageMetadata.DeactivatedMessage

Page has been deactivated.

Arguments: PageMetadata.DeactivatedMessageArguments

PageMetadata.NavigationActivatedMessage

Page was activated by the navigation process.

Arguments: PageMetadata.NavigationActivatedMessageArguments

PageMetadata.NavigationDeactivatedMessage

Page was deactivated by the navigation process.

Arguments: PageMetadata.NavigationDeactivatedMessageArguments

PageMetadata.RegisterToNavigationMessage

Register Page in to navigation system.

Arguments: PageMetadata.RegisterToNavigationdMessageArguments

PageMetadata.UnregisterFromNavigationMessage

Unregister page from navigation system.

Arguments: PageMetadata.UnregisterFromNavigationMessageArguments

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.

PageMetadata.ActivatedMessageArguments

PageMetadata.DeactivatedMessageArguments

PageMetadata.NavigateMessageArguments

ImmediateProperty

Whether to navigate to the page instantly, without playing a transition animation.

Example
local value = arguments:getImmediateProperty()
arguments:setImmediateProperty(value)

PageMetadata.NavigateNextMessageArguments

PageMetadata.NavigateParentMessageArguments

PageMetadata.NavigatePreviousMessageArguments

PageMetadata.NavigationActivatedMessageArguments

PageMetadata.NavigationDeactivatedMessageArguments

PageMetadata.NavigationFinishedMessageArguments

PageMetadata.NavigationStartedMessageArguments

PageMetadata.RegisterToNavigationdMessageArguments

PageMetadata.UnregisterFromNavigationMessageArguments