Get general information about a Kanzi Studio plugin. More...

Public Member Functions
void	Initialize (KanziStudio studio)
	Provides access to KanziStudio object for plugins. More...

Properties
string	Description `[get]`
	Gets the description of the plugin as it is defined in the Description function in the class that implements the PluginCommand interface. More...

string	DisplayName `[get]`
	Gets the name of the plugin that is shown in Kanzi Studio. More...

string	Name `[get]`
	Gets the internal name of the plugin as it is defined in the Name function in the class that implements the PluginCommand interface. More...

Detailed Description

Get general information about a Kanzi Studio plugin.

Member Function Documentation

◆ Initialize()

void Initialize ( KanziStudio studio )

Provides access to KanziStudio object for plugins.

The KanziStudio object is the root object for data access providing the current project, available commands, global undo and redo, events related to project opening and closing. Store KanziStudio object to e.g. a member variable to access it later in other methods, such as in PluginCommand.Execute.

Parameters

studio Kanzi Studio plugin interface.

Property Documentation

◆ Description

string Description

get

Gets the description of the plugin as it is defined in the Description function in the class that implements the PluginCommand interface.

The description of the plugin.

◆ DisplayName

string DisplayName

get

Gets the name of the plugin that is shown in Kanzi Studio.

This name is defined in the DisplayName function in the class that implements the PluginCommand interface.

The name of the plugin that is shown in Kanzi Studio.

◆ Name

string Name

get

Gets the internal name of the plugin as it is defined in the Name function in the class that implements the PluginCommand interface.

The internal name of the plugin.

Public Member Functions