IPluginsRegistryItem interface
No description yet.
public interface IPluginsRegistryItem
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| CategoryGuid | string | get; set | |
| CategoryName | string | get; set | |
| CreatedBy | string | get; set | |
| DateInstalled | double | get; set | |
| GUID | string | get; set | |
| Help | string | get; set | |
| HRID | string | get; set | |
| IsSystem | bool | get; set | |
| LargeImage | string | get; set | |
| LongDescription | string | get; set | |
| Path | string | get; set | |
| ReadMe | string | get; set | |
| ReleasedDate | double | get; set | |
| ReleaseNotes | string | get; set | |
| Requirements | string | get; set | |
| ShortDescription | string | get; set | |
| SmallImage | string | get; set | |
| Status | TPluginsStatus | get; set | |
| Title | string | get; set | |
| VaultGUID | string | get; set | |
| Version | string | get; set | |
| VersionGuid | string | get; set |
CategoryGuid
No description yet.
string GetCategoryGuid();
void SetCategoryGuid(string argValue);
Type: string · Access: read/write
CategoryName
No description yet.
string GetCategoryName();
void SetCategoryName(string argValue);
Type: string · Access: read/write
CreatedBy
No description yet.
string GetCreatedBy();
void SetCreatedBy(string argValue);
Type: string · Access: read/write
DateInstalled
No description yet.
double GetDateInstalled();
void SetDateInstalled(double argValue);
Type: double · Access: read/write
GUID
No description yet.
string GetGUID();
void SetGUID(string argValue);
Type: string · Access: read/write
Help
No description yet.
string GetHelp();
void SetHelp(string argValue);
Type: string · Access: read/write
HRID
No description yet.
string GetHRID();
void SetHRID(string argValue);
Type: string · Access: read/write
IsSystem
No description yet.
bool GetIsSystem();
void SetIsSystem(bool argValue);
Type: bool · Access: read/write
LargeImage
No description yet.
string GetLargeImage();
void SetLargeImage(string argValue);
Type: string · Access: read/write
LongDescription
No description yet.
string GetLongDescription();
void SetLongDescription(string argValue);
Type: string · Access: read/write
Path
No description yet.
string GetPath();
void SetPath(string argValue);
Type: string · Access: read/write
ReadMe
No description yet.
string GetReadMe();
void SetReadMe(string argValue);
Type: string · Access: read/write
ReleasedDate
No description yet.
double GetReleasedDate();
void SetReleasedDate(double argValue);
Type: double · Access: read/write
ReleaseNotes
No description yet.
string GetReleaseNotes();
void SetReleaseNotes(string argValue);
Type: string · Access: read/write
Requirements
No description yet.
string GetRequirements();
void SetRequirements(string argValue);
Type: string · Access: read/write
ShortDescription
No description yet.
string GetShortDescription();
void SetShortDescription(string argValue);
Type: string · Access: read/write
SmallImage
No description yet.
string GetSmallImage();
void SetSmallImage(string argValue);
Type: string · Access: read/write
Status
No description yet.
TPluginsStatus GetStatus();
void SetStatus(TPluginsStatus argValue);
Type: TPluginsStatus · Access: read/write
The accessors are extension methods of IPluginsRegistryItemHelper (using DXP;).
Title
No description yet.
string GetTitle();
void SetTitle(string argValue);
Type: string · Access: read/write
VaultGUID
No description yet.
string GetVaultGUID();
void SetVaultGUID(string argValue);
Type: string · Access: read/write
Version
No description yet.
string GetVersion();
void SetVersion(string argValue);
Type: string · Access: read/write
VersionGuid
No description yet.
string GetVersionGuid();
void SetVersionGuid(string argValue);
Type: string · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| GetPlatformVersions | IPluginsPlatformVersions | |
| StartAutoRun | void | |
| Validate | void |
GetPlatformVersions
No description yet.
IPluginsPlatformVersions GetPlatformVersions();
Returns: IPluginsPlatformVersions
Extension method of IPluginsRegistryItemHelper (using DXP;).
StartAutoRun
No description yet.
void StartAutoRun(TPluginAutoRunAction argutoRunAction);
void StartAutoRun(int argutoRunAction);
| Parameter | Type | Passing |
|---|---|---|
argutoRunAction | TPluginAutoRunAction | value |
Returns: nothing (void)
The first overload is an extension method of IPluginsRegistryItemHelper (using DXP;) with typed parameters; the second is declared by the interface.
Validate
No description yet.
void Validate();
Returns: nothing (void)
Returned by
IPluginsRegistry.CreatePluginsRegistryItem, IPluginsRegistry.FindItemByGUID, IPluginsRegistry.FindItemByHRID, IPluginsRegistry.GetItem
Accepted by
IPluginsRegistry.AddItem, IPluginsRegistry.RemoveItem, IPluginsRegistry.UpdateItem