Access nodes and resources in a Kanzi Studio project. More...

Inherits PropertyContainer, and ChildContainer.

Inherited by AbstractComposer, AbstractEnginePluginContentType, AbstractMaterialType, AccelerationStructure, Animation, AnimationClipBase, ApplicationConfiguration, ApplicationConfigurationItem, BakeableTheme, BindingHost, Brush, Buffer, ChildNodeContainer, ComponentNodeInterface, CubemapTextureInterface, DataObject, DataSource, DerivedMaterialType, DiskRelatedItem, EnginePlugin, EnginePluginContent, EnginePluginContentType, EnginePluginFile, ExportTimeGeneratedTrajectory, ExportedPropertyContainerItem, FileSystemProjectItem, FontFamily, Guide, IBindingSource, IComposerContainer, IConcreteProjectItemLibrary, INodeEffect2DContainer, INodeEffectPrefabTemplate2D, INodePrefabTemplate, IPrefabTemplate, IRenderPassPrefabTemplate, IStyleContainer, ITriggerCondition, ImageFileSource, ImportSourceItem, KzbSource, Material, MaterialVariation, MeshBase, Node, NodeComponent, NodeComponentHost, NodeEffect2D, NodeEffectPrefab2D, NodeResource, ObjectSource, ObservableFile, OrderedChildNodeContainer, OutputMaterial, PageTransition, PageTransitionAnimation, PageTransitionCollection, ParticleSystemGraph, PrefabPlaceholder, PrefabTemplate, PrismGraph, Project, ProjectItemLibrary< out T >, RenderPassPrefab, RenderTarget, ResourceDictionaryItem, Shader, ShaderGraph, Shortcut, SingleTextureInterface, State, StateGroup, StateManager, StudioPluginItem, StyleItem, Tag, Texture, TimelineEntry, TimelineEntryTarget, TimelineSequence, Trajectory, TriggerActionItem, TriggerConditionItem, and WriteLogActionForwardArgument.

Collaboration diagram for ProjectItem:

[legend]

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

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

void	BeginBatchModification (string batchName)
	Begins a batch modification operation.

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 ()
	Commits the current batch modification operation.

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)
	Gets the index of a child project item within this item's children collection.

IEnumerable< Property >	GetContextProperties ()
	Gets the context properties for this project item.

IEnumerable< Property >	GetFixedProperties ()
	Gets the fixed properties for this project item that cannot be removed.

IEnumerable< Property >	GetFrequentlyAddedProperties ()
	Gets the properties that are frequently added to this type of project item.

ProjectItem	GetProjectItemByPath (string path)
	Gets a project item by its path relative to this project item.

string	GetRelativeProjectPathTo (ProjectItem anotherItem)
	Gets the relative path from this project item to another project item.

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)
	Checks whether the specified property is read-only on this project item.

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)
	Sets the index of a child project item within this item's children collection.

void	SetPropertyReadOnlyStatus (Property property, bool? value)
	Sets the read-only status of the specified property on this project item.

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.

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

string	IconLocation `[get]`
	Gets the location of the icon for this project item in Kanzi Studio.

object	IconModifier `[get, set]`
	Gets or sets the icon modifier for this project item.

string	InvalidityReason `[get]`
	Gets the reason why this project item is in an invalid state, or null if the item is valid.

bool	IsDeleted `[get]`
	Gets whether this project item has been deleted.

bool	IsDisposed `[get]`
	Gets whether this project item has been disposed.

bool	IsHidden `[get, set]`
	Gets or sets whether this project item is hidden in Kanzi Studio.

bool	IsReadOnly `[get, set]`
	Gets or sets whether this project item is read-only.

bool	IsValidState `[get]`
	Gets whether this project item is in a valid state.

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]`
	Gets or sets the parent of this project item.

string	Path `[get]`
	Gets the path to this project item within the project.

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

Type	ProjectItemType `[get]`
	Gets the type of this project item.

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.

ProjectItemProperties	PropertyTypes `[get]`

object	this[Property property] `[get, set]`
	Gets or sets the value of the specified property on this project item.

object	this[string propertyName] `[get, set]`
	Gets or sets the value of the property with the specified name on this project item.

string	ToolTip `[get]`
	Gets the tooltip text for this project item in Kanzi Studio.

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.

Events
EventHandler< CollectionChangedEventArgs< ProjectItem > >	ChildCollectionChanged
	Occurs when the children collection of this project item changes.

EventHandler< DeletedEventArgs >	Deleted
	Occurs after this project item has been deleted.

EventHandler< DeletedEventArgs >	Deleting
	Occurs when this project item is about to be deleted.

EventHandler< CollectionChangedEventArgs< ProjectItem > >	DescendantChildCollectionChanged
	Occurs when the children collection of this project item or any of its descendants changes.

EventHandler< DeletedEventArgs >	DescendantDeleted
	Occurs after a descendant of this project item has been deleted.

EventHandler< DynamicPropertyChangedEventArgs >	DescendantDynamicPropertyChanged
	Occurs when a dynamic property value changes on this project item or any of its descendants.

EventHandler< ParentChangedEventArgs >	DescendantParentChanged
	Occurs when the parent of this project item or any of its descendants changes.

EventHandler< CollectionChangedEventArgs< string > >	DescendantPropertyCollectionChanged
	Occurs when a property is added to or removed from this project item or any of its descendants.

EventHandler< ProjectItemEventArgs >	Disposing
	Occurs when this project item is being disposed.

EventHandler< DynamicPropertyChangedEventArgs >	DynamicPropertyChanged
	Occurs when a dynamic property value changes on this project item.

EventHandler< ParentChangedEventArgs >	ParentChanged
	Occurs when the parent of this project item changes.

EventHandler< PathChangedEventArgs >	PathChanged
	Occurs when the path of this project item changes.

EventHandler< DynamicPropertyChangedEventArgs >	PreviewDescendantDynamicPropertyChanged
	Occurs before a dynamic property value changes on this project item or any of its descendants.

EventHandler< DynamicPropertyChangedEventArgs >	PreviewDynamicPropertyChanged
	Occurs before a dynamic property value changes on this project item.

EventHandler< CollectionChangedEventArgs< string > >	PropertyCollectionChanged
	Occurs when a property is added to or removed from this project item.

EventHandler< ReplaceEventArgs >	Replacing
	Occurs when this project item is being replaced.

EventHandler	ThumbnailChanged
	Occurs when the thumbnail of this project item changes.

EventHandler	ValidityChanged
	Occurs when the validity state of this project item changes.

Detailed Description

Access nodes and resources in a Kanzi Studio project.

For example, use this class to get a node, add, remove, or set its properties, find out about its relations to other nodes, get notifications about changes to that node, and to delete the node.

Member Function Documentation

◆ AddProperty() [1/2]

void AddProperty ( Property property )

Adds a property to an item.

When you add a property to a node, the initial value of the property is the default value set for that property. Use the Set function to set the value of a property.

Parameters

property

See also: AddProperty(string), RemoveProperty(Property), RemoveProperty(string)

Examples

To add a property to a node:

        // To add a property to a node, first get or create that node, then use the AddProperty function 
        // to add the property. Use the Set function to set the value of a property. 
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node to which you want to add a node.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Create a Page node named Home in the RootNode node you got in the previous line.
            var homePage = studio.ActiveProject.CreateProjectItem<Page>(
                rootNode.GenerateUniqueChildName("Home"), rootNode);
            // Add the Background Brush property to the Home node.
            homePage.AddProperty(Properties.Node2DBackgroundBrush);
            // Get the DefaultBackground brush in the Brushes library.
            var defaultBackgroundBrush = studio.ActiveProject.BrushLibrary.GetItemByName("DefaultBackground");
            // Set the Background Brush property of the Home node to the DefaultBackground brush.
            homePage.Set(
                homePage.PropertyTypes.Node2DBackgroundBrush,
                new ResourceReference<Brush>(defaultBackgroundBrush));
        }

◆ AddProperty() [2/2]

void AddProperty ( string propertyName )

Adds a property to an item.

When you add a property to a node, the initial value of the property is the default value set for that property. Use the Set function to set the value of a property.

Parameters

propertyName The name of the property to add.

See also: AddProperty(Property), RemoveProperty(string), RemoveProperty(Property)

Examples

To add a property to a node and set the value of the property:

        // To add a property to a node, first get or create that node, then use the AddProperty function
        // to add the property. Use the Set function to set the value of a property. 
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node to which you want to add a property.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Add the Layout Width property to the RootNode node you got in the previous line.
            rootNode.AddProperty("Node.Width");
            // Set the value of the Layout Width property to 1280.
            rootNode.Set("Node.Width", 1280);
        }

To add a property to a node and set the value of the property to a resource:

        // To add a property to a node, first get or create that node, then use the AddProperty function 
        // to add the property. Use the Set function to set the value of a property. 
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node to which you want to add a node.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Create a Page node named Home in the RootNode node you got in the previous line.
            var homePage = studio.ActiveProject.CreateProjectItem<Page>(
                rootNode.GenerateUniqueChildName("Home"), rootNode);
            // Add the Background Brush property to the Home node.
            homePage.AddProperty("Node2D.BackgroundBrush");
            // Get the DefaultBackground brush in the Brushes library.
            var defaultBackgroundBrush = studio.ActiveProject.BrushLibrary.GetItemByName("DefaultBackground");
            // Set the Background Brush property of the Home node to the DefaultBackground brush.
            homePage.Set("Node2D.BackgroundBrush", defaultBackgroundBrush);
        }

◆ BeginBatchModification()

void BeginBatchModification ( string batchName )

Begins a batch modification operation.

Use this to group multiple modifications into a single undo operation.

Parameters

batchName The name of the batch operation for the undo history.

See also: CommitBatchModification

◆ CanAddProperty() [1/2]

bool CanAddProperty ( Property property )

Checks whether Kanzi Studio allows you to add a specific property to an item.

Parameters

property The property.

Returns: True when you can add the property to the item, otherwise false.

See also: CanAddProperty(string), HasProperty(Property), HasProperty(string)

Examples

To check whether Kanzi Studio allows you to add a specific property to a node:

        // To check whether you can add a specific property to a node, first get that node, then
        // use the CanAddProperty function to check whether you can add the property.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node for which you want to check whether you can add a specific property.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // If you can add the Background Brush to the node that you got on the previous line, add it.
            if (rootNode.CanAddProperty(Properties.Node2DBackgroundBrush))
            {
                rootNode.AddProperty(Properties.Node2DBackgroundBrush);
            }
        }

◆ CanAddProperty() [2/2]

bool CanAddProperty ( string propertyName )

Checks whether Kanzi Studio allows you to add a specific property to an item.

Parameters

propertyName The name of the property.

Returns: True when you can add the property to the item, otherwise false.

See also: CanAddProperty(Property), HasProperty(string), HasProperty(Property)

Examples

To check whether Kanzi Studio allows you to add a specific property to a node:

        // To check whether you can add a specific property to a node, first get that node, then
        // use the CanAddProperty function to check whether you can add the property.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node for which you want to check whether you can add a specific property.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // If you can add the Background Brush to the node that you got on the previous line, add it.
            if (rootNode.CanAddProperty("Node2D.BackgroundBrush"))
            {
                rootNode.AddProperty("Node2D.BackgroundBrush");
            }
        }

◆ CommitBatchModification()

void CommitBatchModification ( )

Commits the current batch modification operation.

See also: BeginBatchModification

◆ Delete()

bool Delete ( )

Deletes a project item.

Returns: When it deletes the item successfully, true, otherwise false.

Examples

To delete a node from the node tree:

        // To delete a node you first have to get it, and then use the Delete function to delete it.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the parent node of the node you want to delete.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Get the node you want to delete.
            var defaultViewport2D = rootNode.GetChild("Viewport 2D");
            // Delete the node.
            defaultViewport2D.Delete();
        }

◆ DeregisterThumbnailUser()

void DeregisterThumbnailUser ( object user )

Deregisters a registerd thumbnail user.

Parameters

user	The registered thumbnail user you want to deregister.

See also: GetThumbnail(int, int, bool, bool, Node), RegisterThumbnailUser

◆ GetAddableProperties()

IEnumerable< Property > GetAddableProperties ( )

Gets a list of properties which you can add to an item.

Returns: A list of properties as Property object types which you can add to an item.

See also: GetRemovableProperties, AddProperty(string), AddProperty(Property)

Examples

To get a list of properties which you can add to a node:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node for which you want to get a list of the properties that you can add.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Get the list of properties that you can add and iterate through the list.
            foreach (Property property in rootNode.GetAddableProperties())
            {
                // Print to the Kanzi Studio Log window the names of properties you can add.
                studio.Log(property.Name);
            }
        }

◆ GetAncestor< T >()

T GetAncestor< T > ( )

Gets the nearest item of given type in the parent tree.

The parent tree starts from the item itself, then this.Parent, then this.Parent.Parent, and so on.

Template Parameters

T	The type looked for

Type Constraints

T	:	class
T	:	ProjectItem

◆ GetChild()

ProjectItem GetChild ( string childName )

Gets the child item of the current item with the given name.

For example, use this function to get the child nodes of the current node, or items in any of the Kanzi Studio project libraries, such as Brushes, Textures, Styles, and so on.

Parameters

childName The name of the child item you want to get with this function.

Returns: The child item with matching name, or null if not found.

See also: Children

Examples

To get a node:

        // To get a node you first have to get its parent node, and then use the GetChild function to get its child node.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the parent node of the node you want to get.
            var parentNode = studio.ActiveProject.GetProjectItem("Screens/Screen");
            // Get the RootNode node in the Screens/Screen node.
            var rootNode = parentNode.GetChild("RootNode");
        }

To get a resource:

        // To get a resource you first have to get the library where the resource is stored, 
        // and then use the GetChild function to get the resource in that library.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the Brushes library which stores all the brushes in a Kanzi Studio project.
            var brushLibrary = studio.ActiveProject.BrushLibrary;
            // Get the DefaultBackground texture brush from the Brushes library.
            var defaultBackground = brushLibrary.GetItemByName("DefaultBackground");
        }

◆ GetChild< T >()

T GetChild< T > ( string childName )

Gets the child item of the current item with the given name and type.

For example, use this function to get the child nodes of the current node, or items in any of the Kanzi Studio project libraries, such as Brushes, Textures, Styles, and so on.

Template Parameters

T	The type of the item you want to get with this function.

Parameters

childName The name of the child item you want to get with this function.

Returns: The child item with matching name and type, or null if not found.

See also: Children

Examples

To get a node:

        // To get a node you first have to get its parent node, and then use the GetChild function to get its child node.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the parent node of the node you want to get.
            var parentNode = studio.ActiveProject.GetProjectItem("Screens/Screen");
            // Get the RootNode node in the Screens/Screen node.
            var rootNode = parentNode.GetChild<Page>("RootNode");
        }

To get a resource:

        // To get a resource you first have to get the library where the resource is stored, 
        // and then use the GetChild function to get the resource in that library.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the Brushes library which stores all the brushes in a Kanzi Studio project.
            var brushLibrary = studio.ActiveProject.BrushLibrary;
            // Get the DefaultBackground texture brush from the Brushes library.
            var defaultBackground = brushLibrary.GetChild<Brush>("DefaultBackground");
         }

Type Constraints

T

:

ProjectItem

◆ GetChildIndex()

int GetChildIndex ( ProjectItem child )

Gets the index of a child project item within this item's children collection.

Parameters

child The child project item.

Returns: The zero-based index of the child, or -1 if not found.

See also: SetChildIndex

◆ GetContextProperties()

IEnumerable< Property > GetContextProperties ( )

Gets the context properties for this project item.

Returns: A collection of context properties.

◆ GetFixedProperties()

IEnumerable< Property > GetFixedProperties ( )

Gets the fixed properties for this project item that cannot be removed.

Returns: A collection of fixed properties.

◆ GetFrequentlyAddedProperties()

IEnumerable< Property > GetFrequentlyAddedProperties ( )

Gets the properties that are frequently added to this type of project item.

Returns: A collection of frequently added properties.

◆ GetProjectItemByPath()

ProjectItem GetProjectItemByPath ( string path )

Gets a project item by its path relative to this project item.

Parameters

path	The relative path to the project item.

Returns: The project item at the specified path, or null if not found.

See also: GetRelativeProjectPathTo

◆ GetRelativeProjectPathTo()

string GetRelativeProjectPathTo ( ProjectItem anotherItem )

Gets the relative path from this project item to another project item.

Parameters

anotherItem The target project item.

Returns: The relative path to the target item.

See also: GetProjectItemByPath

◆ GetRemovableProperties()

IEnumerable< Property > GetRemovableProperties ( )

Gets a list of properties which you can remove from an item.

Returns: A list of properties as Property object types which you can remove from an item.

See also: GetAddableProperties, RemoveProperty(string), RemoveProperty(Property)

Examples

To get a list of properties which you can remove from a node:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node for which you want to get a list of the properties that you can remove.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Get the list of properties that you can remove and iterate through the list.
            foreach (Property property in rootNode.GetRemovableProperties())
            {
                // Print to the Kanzi Studio Log window the names of properties you can remove.
                studio.Log(property.Name);
            }
        }

◆ GetThumbnail() [1/2]

BitmapSource GetThumbnail	(	int	width,
		int	height,
		bool	showChildren,
		bool	showFullScreen,
		Node	contextNode )

Gets the thumbnail image for a project item.

If you use the RegisterThumbnailUser function, Kanzi makes the image availabe in cache for quick retrival, otherwise the rendering of the thumbnail takes more time.

Parameters

width	The width of the thumbnail image.
height	The height of the thumbnail image.
showChildren	If set to `true` [show children].
showFullScreen	If set to `true` [show full screen].
contextNode	The context node for resources, such as states, that require a node to display themselves in.

Returns: The thumbnail image of the project item.

◆ GetThumbnail() [2/2]

BitmapSource GetThumbnail	(	int	width,
		int	height,
		bool	showChildren,
		bool	showFullScreen,
		Node	contextNode,
		float[]	letterboxColorRGBA )

Gets the thumbnail image for a project item.

If you use the RegisterThumbnailUser function, Kanzi makes the image availabe in cache for quick retrival, otherwise the rendering of the thumbnail takes more time.

Parameters

width	The width of the thumbnail image.
height	The height of the thumbnail image.
showChildren	If set to `true` [show children].
showFullScreen	If set to `true` [show full screen].
contextNode	The context node for resources, such as states, that require a node to display themselves in.
letterboxColorRGBA	Letter box color

Returns: The thumbnail image of the project item.

◆ GetTreeItemsAsList()

IEnumerable< ProjectItem > GetTreeItemsAsList ( )

Enumerates the items under this ProjectItem including this item itself, children, and grand children.

Returns

◆ HasProperty() [1/2]

bool HasProperty ( Property property )

Checks whether an item has a specific property.

For example, use this function to check for the presence of a specific property before trying to add or remove that property from an item.

Parameters

property The property the presence of which you want to check.

Returns: True when the item has the specified property, otherwise false.

See also: AddProperty(string), AddProperty(Property), RemoveProperty(string), RemoveProperty(Property), CanAddProperty(string), CanAddProperty(Property)

Examples

To check whether a node has a specific property:

        // To check whether a node has a specific property, first get that node, then use 
        // the HasProperty function to check whether the node has that property.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node for which you want to check whether it has a specific property.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Check whether the RootNode node has the Background Brush property.
            bool hasProperty = rootNode.HasProperty(Properties.Node2DBackgroundBrush);
            // If the RootNode node does not have the Background Brush property, add it.
            if (!hasProperty)
            {
                rootNode.AddProperty(Properties.Node2DBackgroundBrush);
            }
        }

◆ HasProperty() [2/2]

bool HasProperty ( string propertyName )

Checks whether an item has a specific property.

For example, use this function to check for the presence of a specific property before trying to add or remove that property from an item.

Parameters

propertyName The name of the property the presence of which you want to check.

Returns: True when the item has the specified property, otherwise false.

See also: AddProperty(string), AddProperty(Property), RemoveProperty(string), RemoveProperty(Property), CanAddProperty(string), CanAddProperty(Property)

Examples

To check whether a node has a specific property:

        // To check whether a node has a specific property, first get that node, then use 
        // the HasProperty function to check whether the node has that property.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node for which you want to check whether it has a specific property.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Check whether the RootNode node has the Background Brush property.
            bool hasProperty = rootNode.HasProperty("Node2D.BackgroundBrush");
            // If the RootNode node does not have the Background Brush property, add it.
            if (!hasProperty)
            {
                rootNode.AddProperty("Node2D.BackgroundBrush");
            }
        }

◆ IsPropertyReadOnly()

bool IsPropertyReadOnly ( Property property )

Checks whether the specified property is read-only on this project item.

Parameters

property The property to check.

Returns: True if the property is read-only, otherwise false.

See also: SetPropertyReadOnlyStatus

◆ RegisterThumbnailUser()

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.

Registering allows you to retrieve thumbnail images in the background before Kanzi sets off the ThumbnailChanged event. After registering, the calls to the GetThumbnail retrieve the cached thumbnail image faster than if you do not register. You must deregister using the DeregisterThumbnailUser function when you are not using the thumbnail images anymore.

Parameters

user	The user.
width	The width of the thumbnail image.
height	The height of the thumbnail image.
showChildren	If set to `true` [show children].
showFullScreen	If set to `true` [show full screen].
contextNode	The context node for resources, such as states, that require a node to display themselves in.

See also: GetThumbnail(int, int, bool, bool, Node), DeregisterThumbnailUser

◆ RemoveProperty() [1/2]

void RemoveProperty ( Property property )

Removes a property from an item.

Parameters

property The property to remove.

See also: RemoveProperty(string), AddProperty(Property), AddProperty(string)

Examples

To remove a property from a node:

        // To remove a property from a node, first get that node, then use the RemoveProperty function 
        // to remove the property.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node from which you want to remove a property.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Remove the Background Brush property from the RootNode node you got in the previous line.
            rootNode.RemoveProperty(Properties.Node2DBackgroundBrush);
        }

◆ RemoveProperty() [2/2]

void RemoveProperty ( string propertyName )

Removes a property from an item.

Parameters

propertyName The name of the property to remove.

See also: RemoveProperty(Property), AddProperty(string), AddProperty(Property)

Examples

To remove a property from a node:

        // To remove a property from a node, first get that node, then use the RemoveProperty function
        // to remove the property.
        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node from which you want to remove a property.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Remove the Background Brush property from the RootNode node you got in the previous line.
            rootNode.RemoveProperty("Node2D.BackgroundBrush");
        }

◆ SetChildIndex()

void SetChildIndex	(	ProjectItem	child,
		int	index )

Sets the index of a child project item within this item's children collection.

Parameters

child	The child project item.
index	The new zero-based index for the child.

See also: GetChildIndex

◆ SetPropertyReadOnlyStatus()

void SetPropertyReadOnlyStatus	(	Property	property,
		bool?	value )

Sets the read-only status of the specified property on this project item.

Parameters

property	The property for which to set the read-only status.
value	The read-only status to set, or null to clear the status.

See also: IsPropertyReadOnly

◆ UpdateValidity()

void UpdateValidity ( )

Recalculates the validity the item.

This can be called if there has happened an external change that affects the validity but has not triggered change in the item itself. This situation can arise e.g. when implementing EditTimeComponentPlugin that returns problem descriptions based on the state of other nodes than the current one.

Property Documentation

◆ Children

IEnumerable<ProjectItem> Children

get

Gets all child items of a project item.

See also: GetChild(string), GetChild<T>(string)

Examples

To get all child nodes of a node:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get all child nodes of the RootNode node.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode").Children;
            // Print the name of each child node of the RootNode node to the Kanzi Studio Log window.
            foreach (var node in rootNode)
            {
                studio.Log(node.Name);
            }
        }

To get all resources from a library:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get all images from the Images directory.
            var imagesDirectory = studio.ActiveProject.ImageDirectory.Children;
            // Print the name of all images in the Images directory to the Kanzi Studio Log window.
            foreach (var resource in imagesDirectory)
            {
                studio.Log(resource.Name);
            }
        }

◆ IconLocation

string IconLocation

get

Gets the location of the icon for this project item in Kanzi Studio.

◆ IconModifier

object IconModifier

getset

Gets or sets the icon modifier for this project item.

◆ InvalidityReason

string InvalidityReason

get

Gets the reason why this project item is in an invalid state, or null if the item is valid.

See also: IsValidState

◆ IsDeleted

bool IsDeleted

get

Gets whether this project item has been deleted.

See also: Delete

◆ IsDisposed

bool IsDisposed

get

Gets whether this project item has been disposed.

◆ IsHidden

bool IsHidden

getset

Gets or sets whether this project item is hidden in Kanzi Studio.

◆ IsReadOnly

bool IsReadOnly

getset

Gets or sets whether this project item is read-only.

◆ IsValidState

bool IsValidState

get

Gets whether this project item is in a valid state.

See also: InvalidityReason

// OKPropertyNameUsage

◆ KzbUrl

string KzbUrl

get

Gets the kzb URL of a project item.

The kzb URL gives you the exact location of a project item. For example, you can use the kzb URL to access a node or a resource in a JavaScript script in your Kanzi application.

Examples

To get the kzb URL of a node:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node whose type you want to get.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Print the .kzb URL of the node to the Kanzi Studio Log window.
            studio.Log(rootNode.KzbUrl);
        }

To get the kzb URL of a resource:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the resource whose type you want to get.
            var texturesLibrary = studio.ActiveProject.TextureLibrary;
            var defaultTexture = texturesLibrary.GetItemByName("Default Texture");
            // Print the .kzb URL of the resource to the Kanzi Studio Log window.
            studio.Log(defaultTexture.KzbUrl);
        }

◆ Name

string Name

getset

Gets or sets the name of a project item.

This is the same value as the value of the Name property. The name must be unique among children of the same parent.

Examples

To get the name of a node:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node whose name you want to get.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Print the name of the node to the Kanzi Studio Log window. In this example it prints "RootNode".
            studio.Log(rootNode.Name);
        }

To get the name of a resource:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the resource whose name you want to get.
            var texturesLibrary = studio.ActiveProject.TextureLibrary;
            var defaultTexture = texturesLibrary.GetItemByName("Default Texture");
            // Print the name of the resource to the Kanzi Studio Log window. In this example it prints "Default Texture".
            studio.Log(defaultTexture.Name);
        }

◆ Parent

ProjectItem Parent

getset

Gets or sets the parent of this project item.

◆ Path

string Path

get

Gets the path to this project item within the project.

◆ Project

Project Project

get

Gets the project in which this item is located.

◆ ProjectItemType

Type ProjectItemType

get

Gets the type of this project item.

◆ PropertyTypeLibrary

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.

After you get the library, you can access and create resources in that library.

Examples

To get all property types in the Property Types library:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the Property Types library which stores all property types you create in a Kanzi Studio project.
            var propertyTypesLibrary = studio.ActiveProject.PropertyTypeLibrary;
            foreach (Property property in propertyTypesLibrary.ProjectPropertyTypes)
            {
                // Print the name of all properties which you can remove to the Kanzi Studio Log window.
                studio.Log(property.Name);
            }
        }

To create your own property type of the integer data type:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the Property Types library which stores all property types you create in a Kanzi Studio project.
            var propertyTypesLibrary = studio.ActiveProject.PropertyTypeLibrary;
            // Create an integer property type in the Property Types library and set:
            // - Name to MyIntProperty
            // - Name as it is shown in Kanzi Studio to My Int Property
            // - Category in which Kanzi Studio shows the property type to My Properties
            // - Lowest value to 0
            // - Highest value to 9000
            // - The amount by which the property can change to 10
            var myIntProperty = studio.ActiveProject.PropertyTypeLibrary.CreateIntProperty(
                propertyTypesLibrary.GenerateUniqueChildName("MyIntProperty"), 
                "My Int Property", 
                "My Properties", 
                0, 
                9000, 
                10);
        }

◆ PropertyTypes

ProjectItemProperties PropertyTypes

get

Implemented in AbstractComposer, AbstractEnginePluginContentType, AbstractMaterialType, AbstractMeshNode, AbstractTheme, AbstractThemeGroup, AndroidBuildConfigurationItem, AngleTrajectory, Animation, AnimationChildClip, AnimationClip, AnimationClipBase, ApplicationConfigurationItem, ApplicationConfigurationResourceFileDirectory, ArcTrajectory, Asset3DImportSourceDirectory, Asset3DSourceFile, BitmapFontFile, BoxMeshNode, Brush, BrushType, Buffer, Button2D, CameraNode, CircleTrajectory, CombineObjectSource, ComponentNode, ComponentNode2D, ComponentType, Composer, ComputeShader, ContainsPropertyFilterObjectSource, CubeMapRenderTargetTexture, CubeMapTexture, DataObject, DataSource, DataSourceType, DerivedMaterialType, DockLayout2D, EllipseTrajectory, EmptyNode, EmptyNode2D, EnginePlugin, EnginePluginFile, FixedSortFilterObjectSource, FlowLayout2D, FontDirectory, FontFamily, FontFile, FragmentShader, GenericResourceFile, GenericResourceFileDirectory, GeometryShader, GridLayout2D, GridListBox2D, Guide, Image2D, ImageDirectory, ImageFile, ImportSourceFile, InstantiatorNode, KzbReferenceItem, KzbSource, LightNode, LineTrajectory, LocalizationTable, Material, MaterialType, MaterialVariation, Mesh, MeshBase, MeshNode, MeshNodeMesh, MessageType, NinePatchImage2D, Node, Node2D, Node2DPrefabPlaceholder, Node2DPrefabTemplate, Node3D, Node3DPrefabPlaceholder, Node3DPrefabTemplate, NodeComponent, NodeComponentType, NodeEffect2D, NodeEffectPrefab2D, NodeEffectType2D, ObjectSource, ObjectTypeFilterObjectSource, ObservableFile, OutputMaterial, Page, PageHost, PageTransition, PageTransitionAnimation, PageTransitionCollection, ParticleSystemGraph, PlaneMeshNode, PrefabTemplate, PrimitiveMeshNode, PrismGraph, ProgressiveRenderingNode2D, Project, ProjectReferenceItem, PropertyIsEqualObjectSource, QNXBuildConfigurationItem, RectangleTrajectory, RenderPass, RenderPassPrefab, RenderPassType, RenderTargetTexture, ResourceDictionaryItem, ResourceFileDirectory, RootObjectSource, Scene, Screen, ScrollView2D, Shader, ShaderGraph, ShaderSourceDirectory, ShaderSourceFile, Shortcut, SingleInputObjectSource, SingleTexture, Slider2D, SourceAssetDirectory, SourceAssetFile, SphereMeshNode, SpiralTrajectory, SplineTrajectory, StackLayout2D, State, StateGroup, StateManager, StudioPluginItem, StyleItem, StyleLibrary, SystemShaderSourceDirectory, SystemShaderSourceFile, Tag, TagFilterObjectSource, TessellationControlShader, TessellationEvaluationShader, TextBlock2D, Texture, ThemeGroup, TimelineEntry, TimelineSequence, ToggleButton2D, ToggleButtonGroup2D, Trajectory, TrajectoryLayout2D, TrapezoidTrajectory, TriggerActionItem, TriggerActionType, TriggerConditionItem, TriggerNodeComponent, TrueTypeFontFile, VertexShader, Viewport2D, VolumeTexture, WindowsBuildConfigurationItem, and WriteLogActionForwardArgument.

◆ this[Property property]

object this[Property property]

getset

Gets or sets the value of the specified property on this project item.

Parameters

property The property to get or set.

Returns: The value of the property.

◆ this[string propertyName]

object this[string propertyName]

getset

Gets or sets the value of the property with the specified name on this project item.

Parameters

propertyName The name of the property to get or set.

Returns: The value of the property.

◆ ToolTip

string ToolTip

get

Gets the tooltip text for this project item in Kanzi Studio.

◆ TypeDisplayName

string TypeDisplayName

get

Gets the type of a project item.

Examples

To get the type of a node:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the node whose type you want to get.
            var rootNode = studio.ActiveProject.GetProjectItem("Screens/Screen/RootNode");
            // Print the type of the node to the Kanzi Studio Log window. In this example it prints "Page Host".
            studio.Log(rootNode.TypeDisplayName);
        }

To get the type of a resource:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the resource whose type you want to get.
            var texturesLibrary = studio.ActiveProject.TextureLibrary;
            var defaultTexture = texturesLibrary.GetItemByName("Default Texture");
            // Print the type of the resource to the Kanzi Studio Log window. In this example it prints "Single Texture".
            studio.Log(defaultTexture.TypeDisplayName);
        }

Event Documentation

◆ ChildCollectionChanged

EventHandler<CollectionChangedEventArgs<ProjectItem> > ChildCollectionChanged

Occurs when the children collection of this project item changes.

See also: DescendantChildCollectionChanged

◆ Deleted

EventHandler<DeletedEventArgs> Deleted

Occurs after this project item has been deleted.

See also: Deleting

◆ Deleting

EventHandler<DeletedEventArgs> Deleting

Occurs when this project item is about to be deleted.

See also: Deleted

◆ DescendantChildCollectionChanged

EventHandler<CollectionChangedEventArgs<ProjectItem> > DescendantChildCollectionChanged

Occurs when the children collection of this project item or any of its descendants changes.

See also: ChildCollectionChanged

◆ DescendantDeleted

EventHandler<DeletedEventArgs> DescendantDeleted

Occurs after a descendant of this project item has been deleted.

See also: Deleted

◆ DescendantDynamicPropertyChanged

EventHandler<DynamicPropertyChangedEventArgs> DescendantDynamicPropertyChanged

Occurs when a dynamic property value changes on this project item or any of its descendants.

See also: DynamicPropertyChanged

◆ DescendantParentChanged

EventHandler<ParentChangedEventArgs> DescendantParentChanged

Occurs when the parent of this project item or any of its descendants changes.

See also: ParentChanged

◆ DescendantPropertyCollectionChanged

EventHandler<CollectionChangedEventArgs<string> > DescendantPropertyCollectionChanged

Occurs when a property is added to or removed from this project item or any of its descendants.

See also: PropertyCollectionChanged

◆ Disposing

EventHandler<ProjectItemEventArgs> Disposing

Occurs when this project item is being disposed.

◆ DynamicPropertyChanged

EventHandler<DynamicPropertyChangedEventArgs> DynamicPropertyChanged

Occurs when a dynamic property value changes on this project item.

See also: PreviewDynamicPropertyChanged

◆ ParentChanged

EventHandler<ParentChangedEventArgs> ParentChanged

Occurs when the parent of this project item changes.

See also: DescendantParentChanged

◆ PathChanged

EventHandler<PathChangedEventArgs> PathChanged

Occurs when the path of this project item changes.

This event does not bubble to parent items.

See also: Path

◆ PreviewDescendantDynamicPropertyChanged

EventHandler<DynamicPropertyChangedEventArgs> PreviewDescendantDynamicPropertyChanged

Occurs before a dynamic property value changes on this project item or any of its descendants.

See also: DescendantDynamicPropertyChanged

◆ PreviewDynamicPropertyChanged

EventHandler<DynamicPropertyChangedEventArgs> PreviewDynamicPropertyChanged

Occurs before a dynamic property value changes on this project item.

See also: DynamicPropertyChanged

◆ PropertyCollectionChanged

EventHandler<CollectionChangedEventArgs<string> > PropertyCollectionChanged

Occurs when a property is added to or removed from this project item.

See also: DescendantPropertyCollectionChanged

◆ Replacing

EventHandler<ReplaceEventArgs> Replacing

Occurs when this project item is being replaced.

◆ ThumbnailChanged

EventHandler ThumbnailChanged

Occurs when the thumbnail of this project item changes.

This event does not bubble to parent items.

◆ ValidityChanged

EventHandler ValidityChanged

Occurs when the validity state of this project item changes.

See also: IsValidState, InvalidityReason

// OKPropertyNameUsage

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AddProperty() [1/2]

◆ AddProperty() [2/2]

◆ BeginBatchModification()

◆ CanAddProperty() [1/2]

◆ CanAddProperty() [2/2]

◆ CommitBatchModification()

◆ Delete()

◆ DeregisterThumbnailUser()

◆ GetAddableProperties()

◆ GetAncestor< T >()

◆ GetChild()

◆ GetChild< T >()

◆ GetChildIndex()

◆ GetContextProperties()

◆ GetFixedProperties()

◆ GetFrequentlyAddedProperties()

◆ GetProjectItemByPath()

◆ GetRelativeProjectPathTo()

◆ GetRemovableProperties()

◆ GetThumbnail() [1/2]

◆ GetThumbnail() [2/2]

◆ GetTreeItemsAsList()

◆ HasProperty() [1/2]

◆ HasProperty() [2/2]

◆ IsPropertyReadOnly()

◆ RegisterThumbnailUser()

◆ RemoveProperty() [1/2]

◆ RemoveProperty() [2/2]

◆ SetChildIndex()

◆ SetPropertyReadOnlyStatus()

◆ UpdateValidity()

Property Documentation

◆ Children

◆ IconLocation

◆ IconModifier

◆ InvalidityReason

◆ IsDeleted

◆ IsDisposed

◆ IsHidden

◆ IsReadOnly

◆ IsValidState

◆ KzbUrl

◆ Name

◆ Parent

◆ Path

◆ Project

◆ ProjectItemType

◆ PropertyTypeLibrary

◆ PropertyTypes

◆ this[Property property]

◆ this[string propertyName]

◆ ToolTip

◆ TypeDisplayName

Event Documentation

◆ ChildCollectionChanged

◆ Deleted

◆ Deleting

◆ DescendantChildCollectionChanged

◆ DescendantDeleted

◆ DescendantDynamicPropertyChanged

◆ DescendantParentChanged

◆ DescendantPropertyCollectionChanged

◆ Disposing

◆ DynamicPropertyChanged

◆ ParentChanged

◆ PathChanged

◆ PreviewDescendantDynamicPropertyChanged

◆ PreviewDynamicPropertyChanged

◆ PropertyCollectionChanged

◆ Replacing

◆ ThumbnailChanged

◆ ValidityChanged