Get or set the first child 2D node of the Screen node. More...

Inheritance diagram for Screen:

Collaboration diagram for Screen:

Properties
Node2D	PreviewRootLayer2D `[get, set]`
	Gets or sets the first child 2D node of the Screen node that the Preview uses.

new ScreenProperties	PropertyTypes `[get]`

Node2D	RootNode2D `[get, set]`
	Gets or sets the first child 2D node of the Screen node.

Properties inherited from Node
IEnumerable< Node >	ChildNodes `[get]`

ResourceDictionary	ResourceDictionary `[get]`

Properties inherited from ProjectItem
IEnumerable< ProjectItem >	Children `[get]`
	Gets all child items of a project item.

string	IconLocation `[get]`

object	IconModifier `[get, set]`

string	InvalidityReason `[get]`

bool	IsDeleted `[get]`

bool	IsDisposed `[get]`

bool	IsHidden `[get, set]`

bool	IsReadOnly `[get, set]`

bool	IsValidState `[get]`

string	KzbUrl `[get]`
	Gets the kzb URL of a project item.

string	Name `[get, set]`
	Gets or sets the name of a project item.

ProjectItem	Parent `[get, set]`

string	Path `[get]`

Project	Project `[get]`
	Gets the project in which this item is located.

Type	ProjectItemType `[get]`

PropertyTypeLibrary	PropertyTypeLibrary `[get]`
	Gets the Property Types library of the project of this item which stores all property types you create in a Kanzi Studio project.

object	this[Property property] `[get, set]`

object	this[string propertyName] `[get, set]`

string	ToolTip `[get]`

string	TypeDisplayName `[get]`
	Gets the type of a project item.

Properties inherited from PropertyContainer
IEnumerable< Property >	Properties `[get]`
	Gets the properties in a project item or node component.

Properties inherited from BindingHost
IEnumerable< Binding >	Bindings `[get]`
	Gets the bindings in a BindingHost.

Properties inherited from NodeComponentHost
IEnumerable< NodeComponent >	NodeComponents `[get]`
	Gets the node components in a NodeComponentHost.

IEnumerable< TriggerNodeComponent >	Triggers `[get]`
	Gets the triggers in a NodeComponentHost.

Additional Inherited Members
Public Member Functions inherited from Node
ResourceDictionary	CreateResourceDictionary ()

void	DeleteResourceDictionary ()

Public Member Functions inherited from ProjectItem
void	AddProperty (Property property)
	Adds a property to an item.

void	AddProperty (string propertyName)
	Adds a property to an item.

void	BeginBatchModification (string batchName)

bool	CanAddProperty (Property property)
	Checks whether Kanzi Studio allows you to add a specific property to an item.

bool	CanAddProperty (string propertyName)
	Checks whether Kanzi Studio allows you to add a specific property to an item.

void	CommitBatchModification ()

bool	Delete ()
	Deletes a project item.

void	DeregisterThumbnailUser (object user)
	Deregisters a registerd thumbnail user.

IEnumerable< Property >	GetAddableProperties ()
	Gets a list of properties which you can add to an item.

T	GetAncestor< T > ()
	Gets the nearest item of given type in the parent tree.

ProjectItem	GetChild (string childName)
	Gets the child item of the current item with the given name.

T	GetChild< T > (string childName)
	Gets the child item of the current item with the given name and type.

int	GetChildIndex (ProjectItem child)

IEnumerable< Property >	GetContextProperties ()

IEnumerable< Property >	GetFixedProperties ()

IEnumerable< Property >	GetFrequentlyAddedProperties ()

ProjectItem	GetProjectItemByPath (string path)

string	GetRelativeProjectPathTo (ProjectItem anotherItem)

IEnumerable< Property >	GetRemovableProperties ()
	Gets a list of properties which you can remove from an item.

BitmapSource	GetThumbnail (int width, int height, bool showChildren, bool showFullScreen, Node contextNode)
	Gets the thumbnail image for a project item.

BitmapSource	GetThumbnail (int width, int height, bool showChildren, bool showFullScreen, Node contextNode, float[] letterboxColorRGBA)
	Gets the thumbnail image for a project item.

IEnumerable< ProjectItem >	GetTreeItemsAsList ()
	Enumerates the items under this ProjectItem including this item itself, children, and grand children.

bool	HasProperty (Property property)
	Checks whether an item has a specific property.

bool	HasProperty (string propertyName)
	Checks whether an item has a specific property.

bool	IsPropertyReadOnly (Property property)

void	RegisterThumbnailUser (object user, uint width, uint height, bool showChildren, bool showFullScreen, Node contextNode)
	Registers a user for the thumbnail images for a project item.

void	RemoveProperty (Property property)
	Removes a property from an item.

void	RemoveProperty (string propertyName)
	Removes a property from an item.

void	SetChildIndex (ProjectItem child, int index)

void	SetPropertyReadOnlyStatus (Property property, bool? value)

void	UpdateValidity ()
	Recalculates the validity the item.

Public Member Functions inherited from PropertyContainer
object	Get (Property property)
	Gets the value of a property.

object	Get (string propertyName)
	Gets the value of a property.

T	Get< T > (TypedProperty< T > property)
	Gets the value of a property.

void	Set (string propertyName, object value)
	Sets the value of a property.

void	Set< T > (TypedProperty< T > property, T value)
	Sets the value of a property.

Public Member Functions inherited from ChildContainer
string	GenerateUniqueChildName (string defaultName)
	Generates a unique name.

string	GetInvalidityReasonOfNewName (string newName)
	Returns the reason why the passed name is not valid.

Public Member Functions inherited from BindingHost
Binding	CreateBinding (Binding sourceBinding)
	Creates a binding by copying an existing binding.

Binding	CreateBinding (Property property, AnimationTargetPropertyAttributeEnum attribute, string code, BindingTypeEnum bindingMode, NodeReferenceBase pushTarget)
	Creates and configures a binding.

Binding	CreateBinding (Property property, AnimationTargetPropertyAttributeEnum attribute, string code, BindingTypeEnum bindingMode=BindingTypeEnum.ONE_WAY)
	Creates and configures a One Way binding.

void	DeleteBinding (Binding binding)
	Deletes a binding.

Public Member Functions inherited from NodeComponentHost
NodeComponent	CreateNodeComponent (NodeComponent sourceNodeComponent)
	Creates a node component by copying an existing node component.

NodeComponent	CreateNodeComponent (string name, NodeComponentType nodeComponentType)
	Creates a node component (Animation, Input Manipulator, or Custom node component).

TriggerNodeComponent	CreateTrigger (NodeComponentType triggerType)
	Creates a trigger.

TriggerNodeComponent	CreateTrigger (TriggerNodeComponent sourceTrigger)
	Creates a trigger by copying an existing trigger.

bool	DeleteNodeComponent (NodeComponent nodeComponent)
	Deletes a node component.

bool	DeleteTrigger (TriggerNodeComponent trigger)
	Deletes a trigger.

Events inherited from ProjectItem
EventHandler< CollectionChangedEventArgs< ProjectItem > >	ChildCollectionChanged

EventHandler< DeletedEventArgs >	Deleted

EventHandler< DeletedEventArgs >	Deleting

EventHandler< CollectionChangedEventArgs< ProjectItem > >	DescendantChildCollectionChanged

EventHandler< DeletedEventArgs >	DescendantDeleted

EventHandler< DynamicPropertyChangedEventArgs >	DescendantDynamicPropertyChanged

EventHandler< ParentChangedEventArgs >	DescendantParentChanged

EventHandler< CollectionChangedEventArgs< string > >	DescendantPropertyCollectionChanged

EventHandler< ProjectItemEventArgs >	Disposing

EventHandler< DynamicPropertyChangedEventArgs >	DynamicPropertyChanged

EventHandler< ParentChangedEventArgs >	ParentChanged

EventHandler< PathChangedEventArgs >	PathChanged

EventHandler< DynamicPropertyChangedEventArgs >	PreviewDescendantDynamicPropertyChanged

EventHandler< DynamicPropertyChangedEventArgs >	PreviewDynamicPropertyChanged

EventHandler< CollectionChangedEventArgs< string > >	PropertyCollectionChanged

EventHandler< ReplaceEventArgs >	Replacing

EventHandler	ThumbnailChanged

EventHandler	ValidityChanged

Detailed Description

Get or set the first child 2D node of the Screen node.

Property Documentation

◆ PreviewRootLayer2D

Node2D PreviewRootLayer2D

getset

Gets or sets the first child 2D node of the Screen node that the Preview uses.

The first child 2D node of the Screen node that the Preview uses.

See also: Project.Screen

◆ PropertyTypes

new ScreenProperties PropertyTypes

get

Implements Node.

◆ RootNode2D

Node2D RootNode2D

getset

Gets or sets the first child 2D node of the Screen node.

The Screen node can have only one child node. This child node can be any 2D node.

The first child 2D node of the Screen node.

See also: Project.Screen

Examples

Get the first child 2D node of the Screen node:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the 2D node under the Screen node.
            var rootNode = studio.ActiveProject.Screen.RootNode2D;
            // Print to the Log window the name of the 2D node under the Screen node.
            studio.Log(rootNode.Name);
        }

Properties

Additional Inherited Members

Detailed Description

Property Documentation

◆ PreviewRootLayer2D

◆ PropertyTypes

◆ RootNode2D