Class Appli.CallParamsInfo_

Represents an information related to a particular plugin function call (e.g. menu item which provoked a plugin call or a supplier for which an order should be generated).

Inheritance

object

Appli.CallParamsInfo_

Appli.CallParamsInfoDirect

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: KD.SDK2

Assembly: KD.SDK2.dll

Syntax

public class Appli.CallParamsInfo_

Properties

Name	Description
ActiveObject	Active object in the current scene or null if no object is active.
Buffer	Buffer allowing a bidirectional exchange of a character string between KitchenDraw and a plugin function.
BufferSize	Size of buffer allowing a bidirectional exchange of a character string between KitchenDraw and a plugin function, in bytes.
CatalogFilename	Filename of a catalog which contained the called plugin function.
Document	The document to be generated or null. Applicable only to plugin functions that generate priced documents (e.g. estimates).
DocumentIndex	Zero based index of the current document being generated among all the documents to be generated in the current generation process.
DocumentsDirectory	Path to the directory where the document generation template files are located (without trailing slash).
DocumentsNumber	The total number of documents to be generated during the current generation process.
IsDocumentGeneratedInSilentMode	Indicates whether the documents are currently generated in silent mode, thus, without showing the documents dialog box.
IsInServerMode	Indicates whether the application was started through a management application and is in "server mode".
OrderDirectory	Directory in which a supplier order being generated should be stored. Applicable only to plugin functions that generate supplier orders.
OrderFilename	Filename for a supplier order being generated. Applicable only to plugin functions that generate supplier orders.
OrderWeek	Delivery week number for a supplier order being generated. Applicable only to plugin functions that generate supplier orders.
OrderYear	Delivery year for a supplier order being generated. Applicable only to plugin functions that generate supplier orders.
Supplier	Supplier of a supplier order being generated or null. Applicable only to plugin functions that generate supplier orders.
SupplierDocumentName	Supplier of a supplier order being generated. Applicable only to plugin functions that generate supplier orders.
UserParameters	User parameter list passed by an external application when calling a KitchenDraw plugin function via DDE or COPYDATA "ExecuteFunction" call.
WebAppId	Identifier of a web browser window firing the OnAppWebDocumentComplete function call.
WebAppUrl	URL displayed in a web browser window firing the OnAppWebDocumentComplete function call.
WindowHandle	Handle of a window in which the plugin function was called.

Methods

Name	Description
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.
GetInfoAsDouble(int)	Gets a value from arbitrary datafield specified by the infoType parameter.
GetInfoAsInt(int)	Gets a value from arbitrary datafield specified by the infoType parameter.