KanziStudio Interface Reference

The entry point for operating with the Kanzi Studio plugin API. More...

Public Member Functions
string	GetFolderPathFromUser (string dialogTitle, string initialDirectory, string userPreferencesSetting)
	Asks a folder path from the user. More...
string	GetPathFromUser (string dialogTitle, string initialDirectory, string userPreferencesSetting, string defaultExtension, string filter, PathDialogType pathDialogType, bool multiselect)
	Asks a file path from the user for either opening or saving a file. More...
void	Log (string message)
	Writes a message to the Studio log window. More...

Detailed Description

The entry point for operating with the Kanzi Studio plugin API.

Member Function Documentation

string GetFolderPathFromUser	(	string	dialogTitle,
		string	initialDirectory,
		string	userPreferencesSetting
	)

Asks a folder path from the user.

Parameters

dialogTitle	The title for the dialog.
initialDirectory	Initial directory where the folder dialog is opened.
userPreferencesSetting	A key to be used for storing the last selected folder in the user preferences.

Returns

The select folder path or null if cancelled.

string GetPathFromUser	(	string	dialogTitle,
		string	initialDirectory,
		string	userPreferencesSetting,
		string	defaultExtension,
		string	filter,
		PathDialogType	pathDialogType,
		bool	multiselect
	)

Asks a file path from the user for either opening or saving a file.

Parameters

dialogTitle	The title for the dialog.
initialDirectory	Initial directory where the file dialog is opened.
userPreferencesSetting	A key to be used for storing the last selected folder in the user preferences.
defaultExtension	The default file extension to use when saving files.
filter	Filter definition for specifying which file extensions the dialog allows to select.
pathDialogType	Type of the dialog. Either PathDialogType.OPEN or PathDialogType.SAVE.
multiselect	Specifies if multiselection is allowed when opening files.

Returns

The selected file path or null if cancelled.

void Log

(

string

message)

Writes a message to the Studio log window.

This can be used to inform the user about the plugin progress.

Parameters

message

The text to write to the log window.