PluginAttribute¶

Summary¶

Sealed class PluginAttribute.

Remarks¶

Marks a class as a Plugin. The Plugin attribute cannot be omitted.

Signature

public sealed class PluginAttribute : Attribute

Namespace¶

cAlgo.API

Examples¶

 using cAlgo.API;
 namespace cAlgo.Plugins
 {
     // This sample plugin shows how to use the Plugin attribute and its properties
     // Every Plugin must be annotated with this attribute
     [Plugin(TimeZone = TimeZones.UTC, AccessRights = AccessRights.None)]
     public class PluginAttributeSample : Plugin
     {
     }
 }

Properties¶

TimeZone¶

Summary

Sets the timezone for all the Plugin datetime references

Remarks

All dates and times within the Plugin will be converted to this timezone

Signature

public string TimeZone {get; set;}

Return Value

string

Examples

 [Plugin(TimeZone = TimeZones.EasternStandardTime)]
 public class NewPlugin : Plugin

AccessRights¶

Summary

Gets or sets the access rights required for the Plugin.

Signature

public AccessRights AccessRights {get; set;}

Return Value

AccessRights

Related Tutorials

Access Rights