Class NSTemplateInfo

Information about a document template, i.e., a document that generally contains unresolved merge tags and that is used as the source for creating new documents.

Constructors

NSTemplateInfo()

Initializes a new instance of the NSTemplateInfo class.

Declaration

NSTemplateInfo

Methods

GetDescription()

Declaration

String GetDescription()

Examples

NSTemplateInfo thing;
String description = thing.GetDescription();

Returns

Type	Description
String	Document description, shown as a tooltip or in some extended description area.

GetExternalReference()

Declaration

String GetExternalReference()

Examples

NSTemplateInfo thing;
String externalReference = thing.GetExternalReference();

Returns

Type	Description
String	Unique key that identifies the document so it can be retrieved.

GetName()

Declaration

String GetName()

Examples

NSTemplateInfo thing;
String name = thing.GetName();

Returns

Type	Description
String	Name of the document, shown in lists etc to the user.

GetPluginId()

Declaration

Integer GetPluginId()

Examples

NSTemplateInfo thing;
Integer pluginId = thing.GetPluginId();

Returns

Type	Description
Integer	ID of plugin that stores this template, so it can be retrieved.

SetDescription(String)

Declaration

Void SetDescription(String description)

Examples

NSTemplateInfo thing;
String description;
thing.SetDescription(description);

Parameters

Type	Name	Description
String	description	Document description, shown as a tooltip or in some extended description area.

Returns

Type	Description
Void

SetExternalReference(String)

Declaration

Void SetExternalReference(String externalReference)

Examples

NSTemplateInfo thing;
String externalReference;
thing.SetExternalReference(externalReference);

Parameters

Type	Name	Description
String	externalReference	Unique key that identifies the document so it can be retrieved.

Returns

Type	Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

NSTemplateInfo thing;
String name;
thing.SetName(name);

Parameters

Type	Name	Description
String	name	Name of the document, shown in lists etc to the user.

Returns

Type	Description
Void

SetPluginId(Integer)

Declaration

Void SetPluginId(Integer pluginId)

Examples

NSTemplateInfo thing;
Integer pluginId;
thing.SetPluginId(pluginId);

Parameters

Type	Name	Description
Integer	pluginId	ID of plugin that stores this template, so it can be retrieved.

Returns

Type	Description
Void