Class FileBasedPluginDescriptor

Plug-in descriptor which loads the plug-in manifest and the plug-in's resources from files on the local file system.

Inheritance
System.Object
FileBasedPluginDescriptor
Implements
Namespace: Sdl.Core.PluginFramework
Assembly: Sdl.Core.PluginFramework.dll
Syntax
public class FileBasedPluginDescriptor : Object, IPluginDescriptor

Constructors

FileBasedPluginDescriptor(String)

Constructs a FileBasedPluginDescriptor using the specified path of a plug-in manifest path.

Declaration
public FileBasedPluginDescriptor(string pluginManifestFilePath)
Parameters
Type Name Description
System.String pluginManifestFilePath

The full path to the plug-in manifest.

Properties

Name

Returns the file name of the plug-in manifest file.

Declaration
public string Name { get; }
Property Value
Type Description
System.String

PluginManifestFilePath

Gets the full plug-in manifest file path.

Declaration
public string PluginManifestFilePath { get; }
Property Value
Type Description
System.String

Methods

GetPluginManifestStream()

Returns a file stream for reading the plug-in manifest file.

Declaration
public Stream GetPluginManifestStream()
Returns
Type Description
System.IO.Stream

A file stream for reading the plug-in manifest file.

GetPluginResource(String)

Gets a plug-in resource by name. This only includes resources that are referred to in the plug-in manifest, such as strings and images.

Declaration
public object GetPluginResource(string name)
Parameters
Type Name Description
System.String name

The resource name.
Returns
Type Description
System.Object
Remarks

When a property of an extsion attribnute or auxiliary extension attribute is merked with the PluginResourceAttribute attribute, any value assigned to it is assumed to be the name of a plug-in resource and can therefore be retrieved using this method.

Implements