KitchenDraw SDK 2
Show / Hide Table of Contents

Class Appli.Plugin

Represents a plugin that is loaded in KitchenDraw.

Inheritance
object
Appli.Plugin
Implements
IEquatable<Appli.Plugin>
Inherited Members
object.ToString()
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetType()
object.MemberwiseClone()
Namespace: KD.SDK2
Assembly: KD.SDK2.dll
Syntax
public class Appli.Plugin : IEquatable<Appli.Plugin>

Properties

Name Description
CatalogFilename

Filename of the catalog (without the path but with extension) containing the plugin if it comes from a catalog resource. Empty string otherwise.

CatalogResourceName

Name of the resource file containing the plugin if it comes from a catalog resource. Empty string otherwise.

EntryNameInSpaceIni

Filename of the plugin exactly as it's provided in SPACE.INI.

Filename

Filename (including a path and an extension) to the file containing the plugin if the plugin doesn't come from a catalog resource. Empty string otherwise.

IsDotNetAssembly

Indicates whether the plugin is a .NET assembly.

IsEnabled

Indicates whether the plugin is enabled in the SPACE.INI file or not. Plugins that aren't enabled are listed in the KitchenDraw UI, but not loaded by default.

IsFromCatalogResource

Indicates whether the plugin comes from a catalog resource.

IsFromCatalogScriptsDirectory

Indicates whether the plugin comes from a script directory for a catalog.

IsLoaded

Indicated whether the plugin is loaded be the KitchenDraw application and thus its plugin functions are called when appropriate.

Rank

Rank of the plugin in the application's plugins list.

TextOfExceptionAppearedOnLoad

If the plugin is failed to load, this property contains the text of the first unhandled exception appeared while loading.

Methods

Name Description
Equals(object)

Determines whether passed object has the same type and value as this one.

GetHashCode()

Provides a numeric value that is used to identify an object in hash-based algorithms.

GetInfo(int)

Gets a value from arbitrary datafield specified by the infoType parameter.

GetInfoAsBool(int)

Gets a value from arbitrary datafield specified by the infoType parameter.

SetInfo(int, bool)

Writes the value to the arbitrary datafield specified by the infoType parameter.

SetInfo(int, string)

Writes the value to the arbitrary datafield specified by the infoType parameter.

TrySetInfo(int, bool)

Writes the value to the arbitrary datafield specified by the infoType parameter.

TrySetInfo(int, string)

Writes the value to the arbitrary datafield specified by the infoType parameter.

Operators

Name Description
operator ==(Plugin, Plugin)

Determines whether two specified instances have the same value.

operator !=(Plugin, Plugin)

Determines whether two specified instances have different values.

In this article
Back to top Generated by DocFX